doxygen filter: do not try to link step- without number

We are currently trying to create a hyperlink for every occurance of
step-BLA found in the documentation. This requires escaping words like
"step-number" using a backslash. This is confusing.
Instead, only do this if the dash is followed by a digit.

Fixes #10489

diff --git a/doc/doxygen/headers/automatic_and_symbolic_differentiation.h b/doc/doxygen/headers/automatic_and_symbolic_differentiation.h
index 119c271d7e0955b2eca7d1adafc5d7852c5ba4df..5d7e1394b92a8bbbd339e06f45cc71aa835887fb 100644 (file)
--- a/doc/doxygen/headers/automatic_and_symbolic_differentiation.h
+++ b/doc/doxygen/headers/automatic_and_symbolic_differentiation.h
@@ -119,7 +119,7 @@
  *    truncation of the Taylor scheme; dual numbers do not contain any higher-order terms in their first derivative,
  *    while for the complex-step method these existent higher-order terms are neglected. It can be shown that
  *    both of these methods are not subject to subtractive cancellation errors and that, within their
- *    finite-difference scheme, they are not numerically sensitive to the internal \step-size chosen for the
+ *    finite-difference scheme, they are not numerically sensitive to the internal step-size chosen for the
  *    numerical perturbation. The dual number approach thus produces exact first derivatives, while the
  *    complex-step approximation does not. The standard implementation of the dual numbers, however, cannot yield
  *    exact values for second derivatives. Hyper-dual numbers take a different view of this idea, with numbers

diff --git a/doc/doxygen/scripts/filter b/doc/doxygen/scripts/filter
index 906834f238e2ea9390cb8365eb7252c400d9b590..c3f5b0b4af1eedbbfbf65fe7f95fc4474958f6e3 100755 (executable)
--- a/doc/doxygen/scripts/filter
+++ b/doc/doxygen/scripts/filter
@@ -87,12 +87,12 @@ while (<>)
     # - things like step-12.solution.png that typically appear in
     #   @image commands.
     # - things in headings
-    s/(?<![\"\\\/])step-(\w+)(?!\")/\@ref step_\1 \"step-\1\"/gi
+    s/(?<![\"\\\/])step-(\d\w*)(?!\")/\@ref step_\1 \"step-\1\"/gi
         if !m/(\@page|\<img|\@image|<h\d>)/i;
 
     # If step-xx was explicitly escaped with a backslash, remove the
     # latter
-    s/\\(step-\w+)/\1/g;
+    s/\\(step-\d\w*)/\1/g;
 
     # doxygen version 1.7.1 and later have the habit of thinking that
     # everything that starts with "file:" is the beginning of a link,

diff --git a/doc/news/5.1.0-vs-5.2.0.h b/doc/news/5.1.0-vs-5.2.0.h
index 9866a9c151a2f51e9f046b8a0029f825bd88a269..e35eb96aeb680970401cf0c0fa30c74b4c9510a3 100644 (file)
--- a/doc/news/5.1.0-vs-5.2.0.h
+++ b/doc/news/5.1.0-vs-5.2.0.h
@@ -217,7 +217,7 @@ inconvenience this causes.
 
   <li> <p>
        New: If there are references to other example programs in any of the
-       \step-XX programs, then they will now show up as crosslinks in the HTML
+       step-XX programs, then they will now show up as crosslinks in the HTML
        version for simpler navigation of the tutorial.
        <br>
        (WB, 2005/04/04)

diff --git a/examples/step-32/step-32.cc b/examples/step-32/step-32.cc
index 0b8df86bdb6aa95f2d84051537fc4f5c7333f3bc..58a976c7b773aadb0b7401af8729b1ebfafb6761 100644 (file)
--- a/examples/step-32/step-32.cc
+++ b/examples/step-32/step-32.cc
@@ -2348,7 +2348,7 @@ namespace Step32
   // The task to be performed by the next three functions is to calculate a
   // mass matrix and a Laplace matrix on the temperature system. These will be
   // combined in order to yield the semi-implicit time stepping matrix that
-  // consists of the mass matrix plus a time \step-dependent weight factor
+  // consists of the mass matrix plus a time step-dependent weight factor
   // times the Laplace matrix. This function is again essentially the body of
   // the loop over all cells from step-31.
   //
@@ -2626,7 +2626,7 @@ namespace Step32
   // In the function that runs the WorkStream for actually calculating the
   // right hand side, we also generate the final matrix. As mentioned above,
   // it is a sum of the mass matrix and the Laplace matrix, times some time
-  // \step-dependent weight. This weight is specified by the BDF-2 time
+  // step-dependent weight. This weight is specified by the BDF-2 time
   // integration scheme, see the introduction in step-31. What is new in this
   // tutorial program (in addition to the use of MPI parallelization and the
   // WorkStream class), is that we now precompute the temperature

diff --git a/examples/step-57/step-57.cc b/examples/step-57/step-57.cc
index 10d265726dfc1e94b11e87d6cdfad34880e4d9aa..d43a68b2e4c156a1c964df82a938057085c015a9 100644 (file)
--- a/examples/step-57/step-57.cc
+++ b/examples/step-57/step-57.cc
@@ -707,7 +707,7 @@ namespace Step57
   //
   // This function will provide us with an initial guess by using a
   // continuation method as we discussed in the introduction. The Reynolds
-  // number is increased \step-by-step until we reach the target value. By
+  // number is increased step-by-step until we reach the target value. By
   // experiment, the solution to Stokes is good enough to be the initial guess
   // of NSE with Reynolds number 1000 so we start there.  To make sure the
   // solution from previous problem is close enough to the next one, the step

diff --git a/examples/step-69/step-69.cc b/examples/step-69/step-69.cc
index 555bb335d9dabe277287d9cb85872aa91ea86202..a3cb6d611cc785afaf06c4908fe0196b3b745330 100644 (file)
--- a/examples/step-69/step-69.cc
+++ b/examples/step-69/step-69.cc
@@ -367,7 +367,7 @@ namespace Step69
   // <code>U</code> and a time point <code>t</code> (as input arguments)
   // computes the updated solution, stores it in the vector
   // <code>temp</code>, swaps its contents with the vector <code>U</code>,
-  // and returns the chosen \step-size $\tau$.
+  // and returns the chosen step-size $\tau$.
   //
   // The other important method is <code>prepare()</code> which primarily
   // sets the proper partition and sparsity pattern for the temporary

diff --git a/examples/step-8/step-8.cc b/examples/step-8/step-8.cc
index 48bb0406f9260c8ab1ce976bcd2871e1507c5a34..0dda834deb27927e29341ff949a65a3886339883 100644 (file)
--- a/examples/step-8/step-8.cc
+++ b/examples/step-8/step-8.cc
@@ -248,7 +248,7 @@ namespace Step8
 
   // The big changes in this program are in the creation of matrix and right
   // hand side, since they are problem-dependent. We will go through that
-  // process \step-by-step, since it is a bit more complicated than in previous
+  // process step-by-step, since it is a bit more complicated than in previous
   // examples.
   //
   // The first parts of this function are the same as before, however: setting