Doxygen for 3.4

Todos:

• empty doxyerr.log - MR !2558 (merged)
• Anything interesting to fix in doxygen.log?
• update parameterlist.txt
• check correct display of the equations
• correct linking of the sites (see sanitizelinks.sh for previous fixes)
• does work on the dumux website as well?
• does the documentation make sense? spot mistakenly made copy& paste?
• does doc/doxygen/modules.txt match the folder structure?, check for missing/wrong ingroup

For possible reference of a future doxygen dude: The documentation is built by running make doc in the dumux build folder. One way to switch doxygen versions is to:

• download the doxygen git repository from https://github.com/doxygen/doxygen.git
• checkout the branch you want, e.g. Release_1_8_17
• the first time do: mkdir build, cd build, cmake -G "Unix Makefiles" ..
• always do in the doxygen build directory: make, sudo make install
• the first time do: export PATH=/usr/local/bin/doxygen:$PATH
• delete the dumux build folder and rerun dunecontrol for dumux ./dune-common/bin/dunecontrol --opts=./dumux/cmake.opts --only=dumux all

After Changes in scr/doxygen.cpp delete the build folder an recreate it.

Related MRs: !2586 (merged), !2590 (merged)

changed milestone to %3.4

added Dumux Day label

mentioned in issue #1009 (closed)

I use Doxygen Release_1_9_1 with the change

diff --git a/src/doxygen.cpp b/src/doxygen.cpp
index 3fdde9bc..39d02971 100644
--- a/src/doxygen.cpp
+++ b/src/doxygen.cpp
@@ -11395,6 +11395,7 @@ void parseInput()
   g_s.begin("Searching for members imported via using declarations...\n");
   // this should be after buildTypedefList in order to properly import
   // used typedefs
+  findUsingDeclImports(root.get()); // may introduce new members !
   findUsingDeclarations(root.get());
   g_s.end();
 
@@ -11460,7 +11461,6 @@ void parseInput()
   g_s.begin("Searching for member function documentation...\n");
   findObjCMethodDefinitions(root.get());
   findMemberDocumentation(root.get()); // may introduce new members !
-  findUsingDeclImports(root.get()); // may introduce new members !
 
   transferRelatedFunctionDocumentation();
   transferFunctionDocumentation();

changed the description

marked the checklist item empty doxyerr.log - MR !2558 (merged) as completed

changed the description

To avoid doing the same work twice, @hanchuan I also see updating the parameterlist.txt as part of my doxygen task.

changed the description

changed the description

marked the checklist item does work on the dumux website as well? as completed

marked the checklist item check correct display of the equations as completed

marked the checklist item correct linking of the sites (see sanitizelinks.sh for previous fixes) as completed

marked the checklist item does the documentation make sense? spot mistakenly made copy& paste? as completed

changed the description

changed the description

marked the checklist item does doc/doxygen/modules.txt match the folder structure?, check for missing/wrong ingroup as completed

marked the checklist item Anything interesting to fix in doxygen.log? as completed

mentioned in merge request !2590 (merged)

created merge request !2592 (closed) to address this issue