From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Fri, 2 Nov 2001 08:27:56 +0000 (+0000)
Subject: Extend the capabilities of the program2html processor and accompanied machinery to... 
X-Git-Tag: v8.0.0~18645
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=42d975716ee40d63ffb6e06f51a391f1451937d9;p=dealii.git

Extend the capabilities of the program2html processor and accompanied machinery to allow for subsection headers within programs, in order to better structurize long program texts.


git-svn-id: https://svn.dealii.org/trunk@5179 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/examples/step-7/step-7.cc b/deal.II/examples/step-7/step-7.cc
index 0f1ea66874..10e939827c 100644
--- a/deal.II/examples/step-7/step-7.cc
+++ b/deal.II/examples/step-7/step-7.cc
@@ -73,19 +73,26 @@
 #include <fstream>
 
 
-
-				 // Since we want to compare the
-				 // exactly known continuous solution
-				 // to the computed one, we need a
-				 // function object which represents
-				 // the continuous solution. On the
-				 // other hand, we need the right hand
-				 // side function, and that one of
-				 // course shares some characteristics
-				 // with the solution. In order to
-				 // reduce dependencies which arise if
-				 // we have to change something in
-				 // both classes at the same time, we
+				 // @sect3{Equation data}
+
+				 // Before implementing the classes
+				 // that actually solve something, we
+				 // first declare and define some
+				 // function classes that represent
+				 // right hand side and solution
+				 // classes. Since we want to compare
+				 // the exactly known continuous
+				 // solution to the computed one, we
+				 // need a function object which
+				 // represents the continuous
+				 // solution. On the other hand, we
+				 // need the right hand side function,
+				 // and that one of course shares some
+				 // characteristics with the
+				 // solution. In order to reduce
+				 // dependencies which arise if we
+				 // have to change something in both
+				 // classes at the same time, we
 				 // exclude the common characteristics
 				 // of both functions into a base
 				 // class.
@@ -331,6 +338,7 @@ double RightHandSide<dim>::value (const Point<dim>   &p,
 };
 
 
+				 // @sect3{The Laplace solver class}
 
 				 // Then we need the class that does
 				 // all the work. It is mostly the
@@ -1732,6 +1740,7 @@ void LaplaceProblem<dim>::run ()
     }
 };
 
+				 // @sect3{Main function}
 
 				 // The main function is mostly as
 				 // before. The only difference is
diff --git a/deal.II/examples/step-9/step-9.cc b/deal.II/examples/step-9/step-9.cc
index e2f811f86e..c735d66bcc 100644
--- a/deal.II/examples/step-9/step-9.cc
+++ b/deal.II/examples/step-9/step-9.cc
@@ -77,6 +77,7 @@
 #  define	M_PI		3.14159265358979323846
 #endif
 
+				 // @sect3{AdvectionProblem class declaration}
 
 				 // Following we declare the main
 				 // class of this program. It is very
@@ -183,6 +184,7 @@ class AdvectionProblem
 
 
 
+				 // @sect3{Equation data declaration}
 
 				 // Next we declare a class that
 				 // describes the advection
@@ -494,6 +496,7 @@ BoundaryValues<dim>::value_list (const std::vector<Point<dim> > &points,
 
 
 
+				 // @sect3{GradientEstimation class declaration}
 
 				 // Now, finally, here comes the class
 				 // that will compute the difference
@@ -620,7 +623,7 @@ class GradientEstimation
 
 
 
-
+				 // @sect3{AdvectionProblem class implementation}
 
 
 				 // Now for the implementation of the
@@ -1410,6 +1413,7 @@ void AdvectionProblem<dim>::run ()
 
 
 
+				 // @sect3{GradientEstimation class implementation}
 
 				 // Now for the implementation of the
 				 // ``GradientEstimation'' class. The
@@ -2030,6 +2034,8 @@ GradientEstimation::estimate_interval (const DoFHandler<dim> &dof_handler,
 };
 
 
+				 // @sect3{Main function}
+
 				 // The ``main'' function is exactly
 				 // like in previous examples, with
 				 // the only difference in the name of