]> https://gitweb.dealii.org/ - dealii.git/commitdiff
fix doxygen documentation generation for tutorial steps 8972/head
authorMatthias Maier <tamiko@43-1.org>
Mon, 28 Oct 2019 17:56:05 +0000 (12:56 -0500)
committerMatthias Maier <tamiko@43-1.org>
Mon, 28 Oct 2019 17:56:05 +0000 (12:56 -0500)
Newer versions seem to be a bit more picky in what they consider a valid
documentation comment.

Thus, make sure to
 - start with "/**" and close with "*/" on the same line
 - remove the only "*" from the first line

doc/doxygen/scripts/make_step.pl

index 58abfb240bd0b587a576af2f0e0e166836ec271c..e1ef0704acce367144d5678b340894a59a9e08f1 100644 (file)
@@ -26,7 +26,7 @@ $cmake_source_dir=$ARGV[1];
 
 print
 "/**
-  * \@page $step_underscore The $step tutorial program
+\@page $step_underscore The $step tutorial program
 ";
 
 open BF, "$cmake_source_dir/examples/$step/doc/builds-on"
@@ -98,5 +98,5 @@ print
 "<a name=\"PlainProg\"></a>
 <h1> The plain program</h1>
 \@include \"$step.$file_extension\"
- */
+*/
 ";

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.