From: Andre Noll <maan@tuebingen.mpg.de>
Date: Thu, 12 Jun 2025 23:16:38 +0000 (+0200)
Subject: Merge topic branch t/doxygen into pu
X-Git-Url: https://git.tuebingen.mpg.de/?a=commitdiff_plain;h=29f4e35f1747cec4b17c9a9e478ee1fc7b133eb2;p=paraslash.git

Merge topic branch t/doxygen into pu

This revamps the doxygen part of the documentation web page, adding a couple
of entry points for users to get started with the code base. We provide links
to header files which descripe the API of central subsystems and links to
the main file of each paraslash executable.

The \file comment of the source files reachable through these links have been
extended to contain a detailed description of the API or executable. Unlike
the introductory text of the manual pages, these comments focus on the code,
particularly the interaction between the various subsystems.

This also reactivates the source browser, since it is actually quite useful
to quickly check for some detail.

<!--

- Major revamp of the source code documention and the documentation web page.

-->

* refs/heads/t/doxygen: (38 commits)
  crypt
  gui
  doc-page
  f
  filter api
  recv
  afs
  afs
  afs
  fec
  doc-site
  send.h
  senders
  send/source-browser
  write
  afh
  afh.h
  f
  afh
  Move detailed desc to top
  ...

# Conflicts:
#	crypt.h
---

29f4e35f1747cec4b17c9a9e478ee1fc7b133eb2
diff --cc crypt.h
index 8ddf2b55,60327098..2d839129
--- a/crypt.h
+++ b/crypt.h
@@@ -196,7 -214,47 +214,7 @@@ void hash_to_asc(const unsigned char *h
   * \param h1 Pointer to the first hash value.
   * \param h2 Pointer to the second hash value.
   *
-  * \return 1, -1, or zero, depending on whether \a h1 is greater than,
-  * less than or equal to h2, respectively.
+  * \return 1, -1, or zero, depending on whether h1 is greater than, less
+  * than or equal to h2, respectively.
   */
  int hash_compare(const unsigned char *h1, const unsigned char *h2);
 -
 -/** Size of the hash value in bytes. */
 -#define HASH2_SIZE 32
 -
 -/**
 - * Compute the hash2 of the given input data.
 - *
 - * \param data Pointer to the data to compute the hash value from.
 - * \param len The length of data in bytes.
 - * \param hash Result pointer.
 - *
 - * The function writes exactly HASH2_SIZE bytes, hence the memory area for
 - * the result must be at least that large.
 - *
 - * \sa sha(3), openssl(1).
 - * */
 -void hash2_function(const char *data, unsigned long len, unsigned char *hash);
 -
 -/**
 - * Convert a hash2 value to ascii format.
 - *
 - * \param hash the hash value.
 - * \param asc Result pointer.
 - *
 - * The function writes exactly 2 * HASH2_SIZE + 1 bytes to fill the result
 - * buffer with the ascii representation of the hash value and a terminating
 - * NUL byte.
 - */
 -void hash2_to_asc(const unsigned char *hash, char *asc);
 -
 -/**
 - * Compare two version 2 hashes.
 - *
 - * \param h1 Pointer to the first hash value.
 - * \param h2 Pointer to the second hash value.
 - *
 - * \return 1, -1, or zero, depending on whether h1 is greater than,
 - * less than or equal to h2, respectively.
 - */
 -int hash2_compare(const unsigned char *h1, const unsigned char *h2);