aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2021-09-29 16:47:48 +0200
committerThomas White <taw@physics.org>2021-09-29 16:47:48 +0200
commit151629cd57e7047683bfce48b393f6e21da9b90d (patch)
treee0019c35761cfe0687675d3b1125bd776a46d294 /libcrystfel/doc
parent9438abb00b495f28c5b2c306fe4d391f6a44acc9 (diff)
Fix Doxygen version numbers
This also removes Doxygen from the CMake build system. It doesn't seem worth trying to make it work both ways. Fixes: https://gitlab.desy.de/thomas.white/crystfel/-/issues/48
Diffstat (limited to 'libcrystfel/doc')
-rw-r--r--libcrystfel/doc/Doxyfile.in4
-rw-r--r--libcrystfel/doc/index.md7
2 files changed, 4 insertions, 7 deletions
diff --git a/libcrystfel/doc/Doxyfile.in b/libcrystfel/doc/Doxyfile.in
index b3d42b18..0c74bfce 100644
--- a/libcrystfel/doc/Doxyfile.in
+++ b/libcrystfel/doc/Doxyfile.in
@@ -38,7 +38,7 @@ PROJECT_NAME = "libcrystfel"
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = @VERSION@
+@INCLUDE = "libcrystfel/Doxyfile-version"
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@@ -251,7 +251,7 @@ TAB_SIZE = 4
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
-ALIASES =
+ALIASES = apirevision=@API_REVISION@
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
diff --git a/libcrystfel/doc/index.md b/libcrystfel/doc/index.md
index f1c72ed4..fc4275f4 100644
--- a/libcrystfel/doc/index.md
+++ b/libcrystfel/doc/index.md
@@ -1,10 +1,5 @@
\mainpage libcrystfel index page
-Version
-=======
-This documentation is for libcrystfel from CrystFEL ${CRYSTFEL_VERSION}, API
-revision ${CRYSTFEL_API_VERSION}.
-
Abstract
========
This is the internal documentation for CrystFEL. Unless you are looking at
@@ -13,6 +8,8 @@ this. You might use the information here when reading the code or to better
understand how the software works, or refer to it when creating a new
program within the suite.
+API revision \apirevision.
+
Coding standards
================
Please see the \ref coding "section on coding standards" for CrystFEL's coding