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

functionObjects: Moved functionObjects namespace documentation into functionObject.H

Browse Source
This commit is contained in:
Henry Weller
2016-05-04 13:56:36 +01:00
parent 52e79b4703
commit 97668c21a3
9 changed files with 94 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
bin/tools/doxyFilter
View File

@ -3,7 +3,7 @@
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
# \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
#------------------------------------------------------------------------------
# License
@ -47,7 +47,6 @@ then
filePath=$realFilePath
fi
# dirName=$(echo "$filePath" | sed -e 's@/[^/]*$@@' )
dirName=${filePath%/[^/]*}
fileName=${filePath##*/}
@ -57,9 +56,6 @@ then
*/applications/solvers/*.C | */applications/utilities/*.C )
awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-top.awk
;;
# */applications/solvers/*.H | */applications/utilities/*.H )
# awkScript=$WM_PROJECT_DIR/bin/tools/doxyFilter-ignore.awk
# ;;
esac
awk -f $WM_PROJECT_DIR/bin/tools/doxyFilter-table.awk $1 | \
@ -70,4 +66,5 @@ then
-e s@%fileName%@$fileName@g \
-e s@%dirName%@$dirName@g
fi
#------------------------------------------------------------------------------

2
bin/tools/doxyFilter-ignore.awk
View File

@ -31,6 +31,7 @@
# to skip documenting all classes/variables
#
#------------------------------------------------------------------------------
BEGIN {
print "//! @file %filePath%"
print "//! @cond OpenFOAMIgnoreAppDoxygen"
@ -41,4 +42,5 @@ BEGIN {
END {
print "//! @endcond"
}
#------------------------------------------------------------------------------

2
bin/tools/doxyFilter-table.awk
View File

@ -131,5 +131,3 @@ BEGIN {
print $0
}
}

9
bin/tools/doxyFilter-top.awk
View File

@ -31,16 +31,17 @@
# block documents the application itself.
#
#------------------------------------------------------------------------------
BEGIN {
state = 0
}
# a '/*' at the beginning of a line starts a comment block
# A '/*' at the beginning of a line starts a comment block
/^ *\/\*/ {
state++
}
# check first line
# Check first line
# either started with a comment or skip documentation for the whole file
FNR == 1 {
if (!state)
@ -50,7 +51,7 @@ FNR == 1 {
}
}
# a '*/' ends the comment block
# A '*/' ends the comment block
# skip documentation for rest of the file
/\*\// {
if (state == 1)
@ -62,7 +63,7 @@ FNR == 1 {
next
}
# print everything within the first comment block
# Print everything within the first comment block
{
if (state)
{

8
bin/tools/doxyFilter.awk
View File

@ -52,16 +52,15 @@ BEGIN {
next
}
/^ *\/\// {
# start comment block
# Start comment block
if (state == 1)
{
printf "/*! "
state = 2
}
# inside comment block
# Inside comment block
if (state == 2)
{
if (!sub(/^ *\/\/ /, ""))
@ -74,9 +73,8 @@ BEGIN {
next
}
{
# end comment block
# End comment block
if (state == 2)
{
printf "*/ "

16
bin/tools/doxyFilter.sed
View File

@ -7,7 +7,7 @@
# equivalent
#------------------------------------------------------------------------------
# new FSF address
# New FSF address
/^License/,/\*\//{
/^License/,\%http://www.gnu.org/licenses%{
s?^License.*?\*\/\
@ -26,7 +26,7 @@ s?^License.*?\*\/\
}
# remove entry
# Remove entry
/^Application *$/{
N
N
@ -34,7 +34,7 @@ d
}
# remove entry
# Remove entry
/^Global *$/{
N
N
@ -79,7 +79,7 @@ s/Class *\n *\(.*\) */\\class \1/
# Group
# groupName
# =>
# \ingroup namespaceName
# \ingroup groupName
#
/^Group *$/,/^[^ ]/{
s/^Group//
@ -108,7 +108,7 @@ s/^ /\\typedef /
}
# add anchor and use \brief
# Add anchor and use \brief
# the first paragraph will be 'brief' and the others 'detail'
/^Description *$/,/^[^ ]/{
/^Description/c\
@ -136,7 +136,7 @@ s/^ //
}
# remove ToDo paragraph to avoid them showing on related pages
# Remove ToDo paragraph to avoid them showing on related pages
/^To[Dd]o *$/,/^[^ ]/{
s/^To[Dd]o *$//
s/^ .*//
@ -174,10 +174,10 @@ s? *\([a-zA-Z0-9]*\.[a-zA-Z]*\)? <li><a href="%dirName%/\1">\1</a></li>?
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
# add a linebreak
# Add a linebreak
s#\\linebreak#<br>#g
}