]> git.tuebingen.mpg.de Git - paraslash.git/commit
Merge topic branch t/doxygen into pu
authorAndre Noll <maan@tuebingen.mpg.de>
Thu, 12 Jun 2025 23:16:38 +0000 (01:16 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Thu, 12 Jun 2025 23:16:38 +0000 (01:16 +0200)
commit29f4e35f1747cec4b17c9a9e478ee1fc7b133eb2
tree4e372fab924f2fc9f496c425af31ab485fabee09
parent74a519640d175936ed6e174ca0afb911ca4c8abf
parent378e8c9c41ec1aae634756eda2665179df1155e2
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
audioc.c
client.c
crypt.h
play.c
web/documentation.in.html