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

doxyFilter: Added support for continuation lines in Doxygen tables

Browse Source 
The continuation line are denoted by the \\ characters at the end of the
previous line e.g.

    \table
        Property     | Description                | Required    | Default value
        setAverage   | Switch to activate setting of average value | no | false
        perturb      | Perturb points for regular geometries | no | 1e-5
        fieldTableName | Alternative field name to sample | no| this field name
        mapMethod    | Type of mapping            | no | planarInterpolation
        offset       | Offset to mapped values    | no | Zero
        dataDir      | Top-level directory of the points and field data \\
                         | no | constant/boundaryData/\<patch name\>
        points       | Path including name of points file relative to dataDir \\
                         | no | points
        sample       | Name of the sub-directory in the time directories \\
                         containing the fields | no | ""
    \endtable
This commit is contained in:
Henry Weller
2017-11-01 21:37:56 +00:00
parent 27632165b2
commit bac518c1f2
2 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
bin/tools/doxyFilter
View File

@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
# \\/ M anipulation |
#------------------------------------------------------------------------------
# License
@ -58,7 +58,8 @@ then
;;
esac
awk -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.awk $1 | \
sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.sed $1 | \
awk -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.awk | \
awk -f $awkScript | \
sed -f $WM_PROJECT_DIR/bin/tools/doxyFilter.sed \
-e s@%realFilePath%@$realFilePath@g \

15
bin/tools/doxyFilter-table.sed Normal file
View File

@ -0,0 +1,15 @@
#------------------------------------------------------------------------------
# Script
# doxyFilter-table.sed
#
# Description
# Splice lines in tables separated by the \\\n continuation tag
#------------------------------------------------------------------------------
/\\\\/{
N
s/\\\\\n */ /
}
#------------------------------------------------------------------------------