From: Siarhei Uzunbajakau Date: Wed, 1 Jan 2025 00:45:55 +0000 (+0100) Subject: Update writing-documentation.html X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1a37dfda301b5eab8a68079029cc5e5181706488;p=dealii.git Update writing-documentation.html Some minor bugs. --- diff --git a/doc/developers/writing-documentation.html b/doc/developers/writing-documentation.html index 40d4777c16..7581bf5765 100644 --- a/doc/developers/writing-documentation.html +++ b/doc/developers/writing-documentation.html @@ -248,9 +248,9 @@ void foobar () of running the program. These three parts are written in separate files: for the step-xx program, for example, they would be in the - files examples/doc/step-xx/doc/intro.dox, - examples/doc/step-xx/step-xx.cc and - examples/doc/step-xx/doc/results.dox. There are a + files dealii/examples/step-xx/doc/intro.dox, + dealii/examples/step-xx/step-xx.cc and + dealii/examples/step-xx/doc/results.dox. There are a number of scripts that then process and concatenate these three different files and send them through doxygen for generation of HTML output. In general, if you want to see how certain markup @@ -268,7 +268,7 @@ void foobar () of deal.II than to run latex, most of the lengthier introductions are just written in latex (with a minimal amount of markup) and later converted into doxygen format. One thing to - be aware of is that you can reference formulas in doxygen, so + be aware of is that you can not reference formulas in doxygen, so you have to work around that using text rather than formula numbers.

@@ -341,9 +341,9 @@ void foobar ()

The actual code

At present, the tools that extract information from the actual example - programs code are rather dumb. They are, to be precise, three Perl + programs code are rather dumb. They are, to be precise, the Perl scripts located in the directory of the - deal.II/doc/doxygen/tutorial tree, where + deal.II/doc/doxygen/scripts tree, where the .cc files of the tutorial programs are converted into doxygen input files. In essence, what these scripts do is to create doxygen input that contains the comments of the program as