From: bangerth Date: Wed, 7 Nov 2012 01:37:37 +0000 (+0000) Subject: Untabify. Doesn't look good in a browser as is currently. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=384cdf3a604fca6e54e291eee767b7194cea871a;p=dealii-svn.git Untabify. Doesn't look good in a browser as is currently. git-svn-id: https://svn.dealii.org/trunk@27451 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/development/writing-documentation.html index fa819b088b..12994d4983 100644 --- a/deal.II/doc/development/writing-documentation.html +++ b/deal.II/doc/development/writing-documentation.html @@ -84,18 +84,18 @@ { public: /** - * Constructor - */ + * Constructor + */ TestClass (); /** - * Example function - */ + * Example function + */ virtual void test () const = 0; /** - * Member variable - */ + * Member variable + */ const unsigned int abc; }; @@ -127,120 +127,120 @@ block is found in the derived class.
  • Itemized lists: - By writing comments like the following, - 
    -	   /**
-	    * <ul>
-	    *   <li> foo
-	    *   <li> bar
-	    * </ul>
-	    */
-
    - you can get itemized lists both in the online and printed - documentation: - - -

    - In other words, one can use standard HTML tags for this - task. Likewise, you can get numbered lists by using the - respective HTML tags <ol>. -

    + By writing comments like the following, + 
    +           /**
+            * <ul>
+            *   <li> foo
+            *   <li> bar
+            * </ul>
+            */
+
    + you can get itemized lists both in the online and printed + documentation: + + +

    + In other words, one can use standard HTML tags for this + task. Likewise, you can get numbered lists by using the + respective HTML tags <ol>. +

  • Verbatim output:

    - If you write comments like this, -

    - 
    -	   /**
-	    * @verbatim
-	    *   void foobar ()
-	    *   {
-	    *     i = 0;
-	    *   }
-	    * @endverbatim
-	    */
-
    - you will get the lines between the verbatim environment with - the same formatting and in typewriter font: - 
    +         If you write comments like this,
+         
    
+         
    +           /**
+            * @verbatim
+            *   void foobar ()
+            *   {
+            *     i = 0;
+            *   }
+            * @endverbatim
+            */
+         
    
+         you will get the lines between the verbatim environment with
+         the same formatting and in typewriter font:
+         
          void foobar ()
      {
        i = 0;
      }
-	 
    
-	 This is useful if you want to include small sample code snippets
-	 into your documentation. In particular, it is important that
-	 the formatting is preserved, which is not the case for all
-	 other text.
+
    + This is useful if you want to include small sample code snippets + into your documentation. In particular, it is important that + the formatting is preserved, which is not the case for all + other text.
  • Typewriter font: -

    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.

    - -

    - 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. -

    +

    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.

    + +

    + 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 or the <em> - HTML tag. To generate boldface, use <b> -

    + To generate output in italics, use the @em + 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. -

    + 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 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. -

    + 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. +

  • Exclusion from documentation:

    doxygen sometimes has problems with inlined - functions of template classes. For these cases (and other cases of - parts of the code to be excluded from documentation), we define a - preprocessor symbol DOXYGEN when running - doxygen. Therefore, the following template can be - used to avoid documentation:

    - 
    -	 documented code here
+         functions of template classes. For these cases (and other cases of
+         parts of the code to be excluded from documentation), we define a
+         preprocessor symbol DOXYGEN when running
+         doxygen. Therefore, the following template can be
+         used to avoid documentation:
    
+         
    +         documented code here
 
-	 #ifndef DOXYGEN
+         #ifndef DOXYGEN
 
-	 code here is compiled, but ignored by doxygen
+         code here is compiled, but ignored by doxygen
 
-	 #endif // DOXYGEN
-	 
    
+         #endif // DOXYGEN
+

    Code examples for the usage of single classes

    @@ -468,4 +468,3 @@ -