From bac518c1f23cb959b6fbf810e2f38d8d6a36cbd9 Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Wed, 1 Nov 2017 21:37:56 +0000 Subject: [PATCH] doxyFilter: Added support for continuation lines in Doxygen tables 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/\ 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 --- bin/tools/doxyFilter | 5 +++-- bin/tools/doxyFilter-table.sed | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 bin/tools/doxyFilter-table.sed diff --git a/bin/tools/doxyFilter b/bin/tools/doxyFilter index c8b9c6761..ff2d24414 100755 --- a/bin/tools/doxyFilter +++ b/bin/tools/doxyFilter @@ -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 \ diff --git a/bin/tools/doxyFilter-table.sed b/bin/tools/doxyFilter-table.sed new file mode 100644 index 000000000..bc6e066b8 --- /dev/null +++ b/bin/tools/doxyFilter-table.sed @@ -0,0 +1,15 @@ +#------------------------------------------------------------------------------ +# Script +# doxyFilter-table.sed +# +# Description +# Splice lines in tables separated by the \\\n continuation tag +#------------------------------------------------------------------------------ + +/\\\\/{ +N +s/\\\\\n */ / +} + + +#------------------------------------------------------------------------------