]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a page to the doxygen documentation that links to the tutorial programs, and...
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 12 Feb 2006 19:48:10 +0000 (19:48 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Sun, 12 Feb 2006 19:48:10 +0000 (19:48 +0000)
git-svn-id: https://svn.dealii.org/trunk@12336 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/convergence_table.h
deal.II/base/include/base/data_out_base.h
deal.II/base/include/base/parameter_handler.h
deal.II/base/include/base/table_handler.h
deal.II/deal.II/include/dofs/dof_handler.h
deal.II/deal.II/include/fe/fe_tools.h
deal.II/deal.II/include/numerics/data_out.h
deal.II/doc/doxygen/headers/tutorial.h [new file with mode: 0644]

index c28460a675dff975a17e94440b2e5bdc4e22af07..596e89e157cc6f1884f34d9ea9e68dcb6dae1dca 100644 (file)
@@ -48,8 +48,8 @@
  * that are not signed to be omitted.
  * </ol>
  *
- * A detailed discussion of this class can also be found in the step-7 and
- * step-13 example programs.
+ * A detailed discussion of this class can also be found in the @ref step_7 "step-7" and
+ * @ref step_13 "step-13" example programs.
  *
  * @ingroup textoutput
  * @author Ralf Hartmann, 1999
index dc9d06b72571a3e4179db05a12a998ffde07f297..71e47ca6280226495be4a28cd64d81132d444a5f 100644 (file)
@@ -1995,7 +1995,7 @@ class DataOutBase
  * generate a single output file from it, which may be again in
  * intermediate format or any of the final formats. This latter option
  * is most helpful for parallel programs: as demonstrated in the
- * step-17 example program, it is possible to let only one processor
+ * @ref step_17 "step-17" example program, it is possible to let only one processor
  * generate the graphical output for the entire parallel program, but
  * this can become vastly inefficient if many processors are involved,
  * because the load is no longer balanced. The way out is to let each
@@ -2769,10 +2769,10 @@ class DataOutInterface : private DataOutBase
  * be merged, while this is almost impossible once the data has been
  * written out in any of the supported established graphics formats.
  *
- * This second use scenario is explained in some detail in the step-18
+ * This second use scenario is explained in some detail in the @ref step_18 "step-18"
  * example program.
  *
- * Both these applications are implemented in the step-19 example program.
+ * Both these applications are implemented in the @ref step_19 "step-19" example program.
  * There, a slight complication is also explained: in order to read data back
  * into this object, you have to know the template parameters for the space
  * dimension which were used when writing the data. If this knowledge is
@@ -2780,7 +2780,7 @@ class DataOutInterface : private DataOutBase
  * (such as in a simple format converted), then it needs to be figured out at
  * run time, even though the compiler already needs it at compile time. A way
  * around using the DataOutBase::determine_intermediate_format_dimensions()
- * function is explained in step-19.
+ * function is explained in @ref step_19 "step-19".
  * 
  *
  * @ingroup input output
@@ -2844,7 +2844,7 @@ class DataOutReader : public DataOutInterface<dim,spacedim>
                                       * patches.
                                      *
                                      * The use of this function is
-                                     * demonstrated in step-19.
+                                     * demonstrated in @ref step_19 "step-19".
                                       */
     void merge (const DataOutReader<dim,spacedim> &other);
     
index dd85c7a418866d6e83a8bef36729d81f53a27784..493353a7018e73375c73bb956cd1bd380797e601 100644 (file)
@@ -768,7 +768,7 @@ namespace Patterns
  *   Input may be sorted into subsection trees in order to give the input a
  *   logical structure.
  *
- *   The ParameterHandler class is discussed in detail in the step-19 example
+ *   The ParameterHandler class is discussed in detail in the @ref step_19 "step-19" example
  *   program.
  *   
  *   <h3>Declaring entries</h3>
index f73a24c8dd27f430387aaa279114966c10c96ff4..b27f60d900486883e9d5386230a1e851312897a6 100644 (file)
@@ -139,7 +139,7 @@ class TableEntry : public TableEntryBase
  * to prescribe the format and the captions the columns are written
  * with in tex mode.
  *
- * A detailed explanation of this class is also given in the step-13 tutorial
+ * A detailed explanation of this class is also given in the @ref step_13 "step-13" tutorial
  * program.
  * 
  * 
index 567c138f1615591b2cb3c051e7113dfff5b18e68..2a4af7d8b7f2ccf17cbab73f0086b9fd38407fea 100644 (file)
@@ -274,10 +274,10 @@ class DoFHandler  :  public Subscriptor
                                      * problem is to use an
                                      * intermediate compressed
                                      * sparsity pattern that only
-                                     * allocated memory on
-                                     * demand. Refer to the step-11
-                                     * example program on how to do
-                                     * this.
+                                     * allocates memory on
+                                     * demand. Refer to the @ref
+                                     * step_11 "step-11" example
+                                     * program on how to do this.
                                      */
     unsigned int max_couplings_between_dofs () const;
 
index 80e9e0cccf41452a8e36bc5377690f6646e1278e..39967576bcb674af0b90aa3ea3c719ffec45c473 100644 (file)
@@ -391,7 +391,7 @@ class FETools
                                       * quadrature points.
                                       *
                                       * A use for this function is described
-                                      * in the introduction to the step-18
+                                      * in the introduction to the @ref step_18 "step-18"
                                       * example program.
                                       *
                                       * The opposite of this function,
index 49d2bae3fbfaf229c52b7c5111cd88eb2a7ca18c..c9a3825e70e0b22d188744cfa73674834769d66e 100644 (file)
@@ -835,7 +835,7 @@ class DataOut_DoFData : public DataOutInterface<patch_dim,patch_space_dim>
  * By default, this class produces patches for all active cells. Sometimes,
  * this is not what you want, maybe because they are simply too many (and too
  * small to be seen individually) or because you only want to see a certain
- * region of the domain (for example in parallel programs such as the step-18
+ * region of the domain (for example in parallel programs such as the @ref step_18 "step-18"
  * example program), or for some other reason.
  *
  * For this, internally build_patches() does not generate
diff --git a/deal.II/doc/doxygen/headers/tutorial.h b/deal.II/doc/doxygen/headers/tutorial.h
new file mode 100644 (file)
index 0000000..55474e1
--- /dev/null
@@ -0,0 +1,117 @@
+//-------------------------------------------------------------------------
+//    $Id$
+//    Version: $Name$
+//
+//    Copyright (C) 2005, 2006 by the deal.II authors
+//
+//    This file is subject to QPL and may not be  distributed
+//    without copyright and license information. Please refer
+//    to the file deal.II/doc/license.html for the  text  and
+//    further information on this license.
+//
+//-------------------------------------------------------------------------
+
+/**
+ * @page Tutorial Tutorial programs
+ *
+ * The tutorial is a separate part of the documentation for deal.II
+ * (in fact, the second part, next to the manual you are presently
+ * in). It consists of a collection of small programs, each more or
+ * less built atop of the previous ones, which demonstrate various
+ * aspects of the library. A more detailed overview can be found <a
+ * href="../../tutorial/chapter-2.step-by-step/index.html">on this
+ * page</a> that also includes short summaries of what each of the
+ * tutorial programs are supposed to demonstrate.
+ *
+ * The tutorial programs are named step-1, step-2, etc. If you want to
+ * jump to any of these programs directly, simply follow one of the
+ * links below:
+ * 
+ * <ul>
+ *
+ * <li>
+ * @anchor step_1 <a href="../../tutorial/chapter-2.step-by-step/step-1.html">step-1</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_2 <a href="../../tutorial/chapter-2.step-by-step/step-2.html">step-2</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_3 <a href="../../tutorial/chapter-2.step-by-step/step-3.html">step-3</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_4 <a href="../../tutorial/chapter-2.step-by-step/step-4.html">step-4</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_5 <a href="../../tutorial/chapter-2.step-by-step/step-5.html">step-5</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_6 <a href="../../tutorial/chapter-2.step-by-step/step-6.html">step-6</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_7 <a href="../../tutorial/chapter-2.step-by-step/step-7.html">step-7</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_8 <a href="../../tutorial/chapter-2.step-by-step/step-8.html">step-8</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_9 <a href="../../tutorial/chapter-2.step-by-step/step-9.html">step-9</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_10 <a href="../../tutorial/chapter-2.step-by-step/step-10.html">step-10</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_11 <a href="../../tutorial/chapter-2.step-by-step/step-11.html">step-11</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_12 <a href="../../tutorial/chapter-2.step-by-step/step-12.html">step-12</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_13 <a href="../../tutorial/chapter-2.step-by-step/step-13.html">step-13</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_14 <a href="../../tutorial/chapter-2.step-by-step/step-14.html">step-14</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_15 <a href="../../tutorial/chapter-2.step-by-step/step-15.html">step-15</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_16 <a href="../../tutorial/chapter-2.step-by-step/step-16.html">step-16</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_17 <a href="../../tutorial/chapter-2.step-by-step/step-17.html">step-17</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_18 <a href="../../tutorial/chapter-2.step-by-step/step-18.html">step-18</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_19 <a href="../../tutorial/chapter-2.step-by-step/step-19.html">step-19</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_20 <a href="../../tutorial/chapter-2.step-by-step/step-20.html">step-20</a>
+ * </li>
+ * 
+ * <li>
+ * @anchor step_21 <a href="../../tutorial/chapter-2.step-by-step/step-21.html">step-21</a>
+ * </li>
+ * 
+ * </ul>
+ */

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.