From: Wolfgang Bangerth Date: Sun, 12 Feb 2006 19:48:10 +0000 (+0000) Subject: Add a page to the doxygen documentation that links to the tutorial programs, and... X-Git-Tag: v8.0.0~12344 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c66a3984bad83f9dd0b3abc8b268d1c307822126;p=dealii.git Add a page to the doxygen documentation that links to the tutorial programs, and add links from the class documentations to this tutorial page. git-svn-id: https://svn.dealii.org/trunk@12336 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/convergence_table.h b/deal.II/base/include/base/convergence_table.h index c28460a675..596e89e157 100644 --- a/deal.II/base/include/base/convergence_table.h +++ b/deal.II/base/include/base/convergence_table.h @@ -48,8 +48,8 @@ * that are not signed to be omitted. * * - * 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 diff --git a/deal.II/base/include/base/data_out_base.h b/deal.II/base/include/base/data_out_base.h index dc9d06b725..71e47ca628 100644 --- a/deal.II/base/include/base/data_out_base.h +++ b/deal.II/base/include/base/data_out_base.h @@ -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 * patches. * * The use of this function is - * demonstrated in step-19. + * demonstrated in @ref step_19 "step-19". */ void merge (const DataOutReader &other); diff --git a/deal.II/base/include/base/parameter_handler.h b/deal.II/base/include/base/parameter_handler.h index dd85c7a418..493353a701 100644 --- a/deal.II/base/include/base/parameter_handler.h +++ b/deal.II/base/include/base/parameter_handler.h @@ -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. * *

Declaring entries

diff --git a/deal.II/base/include/base/table_handler.h b/deal.II/base/include/base/table_handler.h index f73a24c8dd..b27f60d900 100644 --- a/deal.II/base/include/base/table_handler.h +++ b/deal.II/base/include/base/table_handler.h @@ -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. * * diff --git a/deal.II/deal.II/include/dofs/dof_handler.h b/deal.II/deal.II/include/dofs/dof_handler.h index 567c138f16..2a4af7d8b7 100644 --- a/deal.II/deal.II/include/dofs/dof_handler.h +++ b/deal.II/deal.II/include/dofs/dof_handler.h @@ -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; diff --git a/deal.II/deal.II/include/fe/fe_tools.h b/deal.II/deal.II/include/fe/fe_tools.h index 80e9e0cccf..39967576bc 100644 --- a/deal.II/deal.II/include/fe/fe_tools.h +++ b/deal.II/deal.II/include/fe/fe_tools.h @@ -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, diff --git a/deal.II/deal.II/include/numerics/data_out.h b/deal.II/deal.II/include/numerics/data_out.h index 49d2bae3fb..c9a3825e70 100644 --- a/deal.II/deal.II/include/numerics/data_out.h +++ b/deal.II/deal.II/include/numerics/data_out.h @@ -835,7 +835,7 @@ class DataOut_DoFData : public DataOutInterface * 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 index 0000000000..55474e165b --- /dev/null +++ b/deal.II/doc/doxygen/headers/tutorial.h @@ -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 on this + * page 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: + * + *
    + * + *
  • + * @anchor step_1 step-1 + *
  • + * + *
  • + * @anchor step_2 step-2 + *
  • + * + *
  • + * @anchor step_3 step-3 + *
  • + * + *
  • + * @anchor step_4 step-4 + *
  • + * + *
  • + * @anchor step_5 step-5 + *
  • + * + *
  • + * @anchor step_6 step-6 + *
  • + * + *
  • + * @anchor step_7 step-7 + *
  • + * + *
  • + * @anchor step_8 step-8 + *
  • + * + *
  • + * @anchor step_9 step-9 + *
  • + * + *
  • + * @anchor step_10 step-10 + *
  • + * + *
  • + * @anchor step_11 step-11 + *
  • + * + *
  • + * @anchor step_12 step-12 + *
  • + * + *
  • + * @anchor step_13 step-13 + *
  • + * + *
  • + * @anchor step_14 step-14 + *
  • + * + *
  • + * @anchor step_15 step-15 + *
  • + * + *
  • + * @anchor step_16 step-16 + *
  • + * + *
  • + * @anchor step_17 step-17 + *
  • + * + *
  • + * @anchor step_18 step-18 + *
  • + * + *
  • + * @anchor step_19 step-19 + *
  • + * + *
  • + * @anchor step_20 step-20 + *
  • + * + *
  • + * @anchor step_21 step-21 + *
  • + * + *
+ */