From de4c018b19f692398a04accc5f8ed7b5cdf2bfdf Mon Sep 17 00:00:00 2001 From: Henry Weller <http://cfd.direct> Date: Fri, 17 Jun 2016 17:13:39 +0100 Subject: [PATCH] Doxygen documentation: Remove superfluous linebreak --- bin/tools/doxyFilter.sed | 3 --- .../db/functionObjects/functionObject/functionObject.H | 1 - .../field/fieldValues/fieldValueDelta/fieldValueDelta.H | 2 +- .../field/fieldValues/surfaceRegion/surfaceRegion.H | 3 --- src/functionObjects/field/fieldValues/volRegion/volRegion.H | 2 -- src/functionObjects/field/streamLine/streamLine.H | 1 - .../field/wallBoundedStreamLine/wallBoundedStreamLine.H | 1 - 7 files changed, 1 insertion(+), 12 deletions(-) diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index cfb3b8a85f8..b7b28a86215 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -177,9 +177,6 @@ s/.*\*\//\*\// # Convert /heading in source files to bold font and add some space s#\\heading \(.*\)#<br><b>\1</b>#g -# Add a linebreak -s#\\linebreak#<br>#g - } #------------------------------------------------------------------------------ diff --git a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H index 632f615cb18..8bf20a0f281 100644 --- a/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H +++ b/src/OpenFOAM/db/functionObjects/functionObject/functionObject.H @@ -32,7 +32,6 @@ Description field and derived quantities. Alternatively, the same actions can be executed after the simulation using the \c -postProcess command-line option. - \linebreak \subsection secFunctionObjects Using function objects FunctionObjects are selected by additional entries in the diff --git a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H index 12267d588f7..f40461a7222 100644 --- a/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H +++ b/src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H @@ -56,7 +56,6 @@ Description type | type name: fieldValueDelta | yes | \endtable - \linebreak The \c operation is one of: \plaintable add | add @@ -65,6 +64,7 @@ Description max | maximum average | average \endplaintable + SeeAlso Foam::fieldValue diff --git a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H index 3d314a24dcc..fbe1182262a 100644 --- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H +++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H @@ -33,7 +33,6 @@ Description of mesh (or general surface) faces, a number of operations can be performed, such as sums, averages and integrations. - \linebreak For example, to calculate the volumetric or mass flux across a patch, apply the 'sum' operator to the flux field (typically \c phi) @@ -78,7 +77,6 @@ Description orientedFields | list of oriented fields to operate on | no | \endtable - \linebreak Where \c regionType is defined by \plaintable faceZone | requires a 'name' entry to specify the faceZone @@ -86,7 +84,6 @@ Description sampledSurface | requires a 'sampledSurfaceDict' sub-dictionary \endplaintable - \linebreak The \c operation is one of: \plaintable none | no operation diff --git a/src/functionObjects/field/fieldValues/volRegion/volRegion.H b/src/functionObjects/field/fieldValues/volRegion/volRegion.H index 9f9d54a0fe6..3e0650c4140 100644 --- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H +++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H @@ -69,14 +69,12 @@ Description fields | list of fields to operate on | yes | \endtable - \linebreak Where \c regionType is defined by \plaintable cellZone | requires a 'name' entry to specify the cellZone all | all cells \endplaintable - \linebreak The \c operation is one of: \plaintable none | no operation diff --git a/src/functionObjects/field/streamLine/streamLine.H b/src/functionObjects/field/streamLine/streamLine.H index c34d6ad937c..e47fcf984f7 100644 --- a/src/functionObjects/field/streamLine/streamLine.H +++ b/src/functionObjects/field/streamLine/streamLine.H @@ -76,7 +76,6 @@ Description seedSampleSet| Seeding method (see below)| yes | \endtable - \linebreak Where \c seedSampleSet is typically one of \plaintable uniform | uniform particle seeding diff --git a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index 94e1e3fa00d..2061af85c93 100644 --- a/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -76,7 +76,6 @@ Description seedSampleSet| Seeding method (see below)| yes | \endtable - \linebreak Where \c seedSampleSet is typically one of \plaintable uniform | uniform particle seeding -- GitLab