From 2b72b0e2dd1eec682aa6fdea7ba8466b2b5b98ab Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Mon, 7 Mar 2005 16:13:56 +0000 Subject: [PATCH] Style updated to the use of doxygen git-svn-id: https://svn.dealii.org/trunk@10033 0785d39b-7218-0410-832d-ea1e28bc413d --- .../development/writing-documentation.html | 66 ++++++++++++++----- 1 file changed, 51 insertions(+), 15 deletions(-) diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html index 4c399c3826..4fe93f3107 100644 --- a/deal.II/doc/development/writing-documentation.html +++ b/deal.II/doc/development/writing-documentation.html @@ -164,33 +164,55 @@

  • Typewriter font: +

    - One would often like to use a typewriter font for variable, - function, or class names. For this, the @p - one_word_without_spaces tag is used, which generates - output in which the single word after the tag is set in - typewriter font. If you want to put multiple words into - typewriter font, then enclosing them in the HTML - <tt> is the way to go. + In order to use typewriter font for instance for function + arguments or variables, use the <tt> HTML + tag. For a single word, you can also use the form @p + one_word_without_spaces.

    - As a convention, we always write variable and function - names as @p name in order to give them a visible - distinction. + If you refer to member variables and member functions + doxygen has better options than this: use + function_name() to reference member functions and + #variable_name for member variables to create links + automatically. Refer to the documentation of doxygen to + get even more options for global variables.

  • Emphasis:

    To generate output in italics, use the @em - one_word_without_spaces tag. + one_word_without_spaces tag or the <em> + HTML tag. To generate boldface, use <b> +

    + +
  • Formulæ: +

    + For simple and short formulæ use the <i> + HTML tag. Remark that you can use <sub> and + <sup> to get subscripts an superscripts, + resp. Only for longer formulæ use + $formula$ to generate an LaTeX formula which will be + included as a graphical image.

  • Sections:

    - Sections can be generated using @section TAG Section_name, - tag. Here, TAG is a symbolic name for the - section, which can be used for cross references. + Sections in class and function documentations can be + generated using the <hN> HTML headline + tags. Headlines inside class documentation should start at + level 3 (<h3>) to stay consistent with the + structure of the doxygen output. +

    + +

    + Sections cannot be referenced, unless you add a <A + NAME="..."> name anchor to them. If you really have + to do this, please make sure the name does not interfere with + doxygen generated anchors.

    @@ -200,6 +222,7 @@

    Writing example programs

    +

    The Tutorial

    At present, the tools that extract information from the example programs are rather dumb. They are, to be precise, two Perl @@ -221,7 +244,20 @@ something along these lines.

    - +

    Code examples for the usage of single classes

    +

    + Writing example files for classes is supported by + doxygen. These example files go into + deal.II/examples/doxygen. If they are short, + documentation should be inside and they are included into the + documentation with @include filename. +

    + +

    + Larger example files should be documented using the + doxygen command @dotinclude and + related commands. +


    -- 2.39.5