zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

ENH: support longer doxygen brief descriptions.

Browse Source
This commit is contained in:
Mark Olesen
2017-11-04 14:26:38 +01:00
parent 695716d5cc
commit ebd922a32e
12 changed files with 148 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
bin/tools/doxyFilter.awk
View File

@ -3,7 +3,7 @@
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
# \\/ M anipulation |
# \\/ M anipulation | Copyright (C) 2017 OpenCFD Ltd.
#------------------------------------------------------------------------------
# License
# This file is part of OpenFOAM.
@ -29,40 +29,67 @@
#
# Assumes comment strings are formatted as follows
# //- General description
# // more information
# // Detailed information
# // and even more information
# or
# //- General description
# //- that spans several
# //- lines
# // Detailed information
# // and even more information
#
# This should be re-formatted as the following
# //! general description
# /*!
# more information
# /*! \brief General description
# that spans several
# lines
# */
# /*! Detailed information
# and even more information
# */
#
# The intermediate "/*! ... */" block is left-justified to handle
# possible verbatim text
#
#------------------------------------------------------------------------------
# States: 0=normal, 1=brief, 2=details
BEGIN {
state = 0
}
/^ *\/\/-/ {
state = 1
sub(/\/\/-/, "//!")
if (state == 0)
{
# Changed from normal to brief (start of comment block)
printf "/*! \\brief"
state = 1
}
if (state == 1)
{
# Within brief: strip leading
if (!sub(/^ *\/\/- /, ""))
{
sub(/^ *\/\/-/, "")
}
}
print
next
}
/^ *\/\// {
# Start comment block
if (state == 1)
{
# Change from brief to details
printf "*/\n"
printf "/*! "
state = 2
}
# Inside comment block
if (state == 2)
{
# Within details: strip leading
if (!sub(/^ *\/\/ /, ""))
{
sub(/^ *\/\//, "")
@ -74,10 +101,10 @@ BEGIN {
}
{
# End comment block
if (state == 2)
# End comment filtering
if (state)
{
printf "*/ "
printf "*/\n"
}
state = 0
print