zhyang-dev/OpenFOAM-6
1
0
Fork 0
mirror of https://github.com/OpenFOAM/OpenFOAM-6.git synced 2025-12-08 06:57:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doxygen documentation: Remove superfluous linebreak

Browse Source
This commit is contained in:
Henry Weller
2016-06-17 17:13:39 +01:00
parent 2668106e2c
commit 4ebaed67f9
7 changed files with 1 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
bin/tools/doxyFilter.sed
View File

@ -177,9 +177,6 @@ s/.*\*\//\*\//
# Convert /heading in source files to bold font and add some space # Convert /heading in source files to bold font and add some space
s#\\heading \(.*\)#<br><b>\1</b>#g s#\\heading \(.*\)#<br><b>\1</b>#g
# Add a linebreak
s#\\linebreak#<br>#g
} }
#------------------------------------------------------------------------------ #------------------------------------------------------------------------------

1
src/OpenFOAM/db/functionObjects/functionObject/functionObject.H
View File

@ -32,7 +32,6 @@ Description
field and derived quantities. Alternatively, the same actions can be field and derived quantities. Alternatively, the same actions can be
executed after the simulation using the \c -postProcess command-line option. executed after the simulation using the \c -postProcess command-line option.
\linebreak
\subsection secFunctionObjects Using function objects \subsection secFunctionObjects Using function objects
FunctionObjects are selected by additional entries in the FunctionObjects are selected by additional entries in the

2
src/functionObjects/field/fieldValues/fieldValueDelta/fieldValueDelta.H
View File

@ -56,7 +56,6 @@ Description
type | type name: fieldValueDelta | yes | type | type name: fieldValueDelta | yes |
\endtable \endtable
\linebreak
The \c operation is one of: The \c operation is one of:
\plaintable \plaintable
add | add add | add
@ -65,6 +64,7 @@ Description
max | maximum max | maximum
average | average average | average
\endplaintable \endplaintable
SeeAlso SeeAlso
Foam::fieldValue Foam::fieldValue

3
src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H
View File

@ -33,7 +33,6 @@ Description
of mesh (or general surface) faces, a number of operations can be of mesh (or general surface) faces, a number of operations can be
performed, such as sums, averages and integrations. performed, such as sums, averages and integrations.
\linebreak
For example, to calculate the volumetric or mass flux across a patch, For example, to calculate the volumetric or mass flux across a patch,
apply the 'sum' operator to the flux field (typically \c phi) 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 | orientedFields | list of oriented fields to operate on | no |
\endtable \endtable
\linebreak
Where \c regionType is defined by Where \c regionType is defined by
\plaintable \plaintable
faceZone | requires a 'name' entry to specify the faceZone faceZone | requires a 'name' entry to specify the faceZone
@ -86,7 +84,6 @@ Description
sampledSurface | requires a 'sampledSurfaceDict' sub-dictionary sampledSurface | requires a 'sampledSurfaceDict' sub-dictionary
\endplaintable \endplaintable
\linebreak
The \c operation is one of: The \c operation is one of:
\plaintable \plaintable
none | no operation none | no operation

2
src/functionObjects/field/fieldValues/volRegion/volRegion.H
View File

@ -69,14 +69,12 @@ Description
fields | list of fields to operate on | yes | fields | list of fields to operate on | yes |
\endtable \endtable
\linebreak
Where \c regionType is defined by Where \c regionType is defined by
\plaintable \plaintable
cellZone | requires a 'name' entry to specify the cellZone cellZone | requires a 'name' entry to specify the cellZone
all | all cells all | all cells
\endplaintable \endplaintable
\linebreak
The \c operation is one of: The \c operation is one of:
\plaintable \plaintable
none | no operation none | no operation

1
src/functionObjects/field/streamLine/streamLine.H
View File

@ -76,7 +76,6 @@ Description
seedSampleSet| Seeding method (see below)| yes | seedSampleSet| Seeding method (see below)| yes |
\endtable \endtable
\linebreak
Where \c seedSampleSet is typically one of Where \c seedSampleSet is typically one of
\plaintable \plaintable
uniform | uniform particle seeding uniform | uniform particle seeding

1
src/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H
View File

@ -76,7 +76,6 @@ Description
seedSampleSet| Seeding method (see below)| yes | seedSampleSet| Seeding method (see below)| yes |
\endtable \endtable
\linebreak
Where \c seedSampleSet is typically one of Where \c seedSampleSet is typically one of
\plaintable \plaintable
uniform | uniform particle seeding uniform | uniform particle seeding