Commit e5f0dd3e authored by Mark Olesen's avatar Mark Olesen
Browse files

Doxygen cleanups

  * skip doxygen docs for local variables (treeBoundBox)
  * filter transforms 'Typedef' -> @typedef
  * added tools/find-retagged
  * manually changed some InClass tags to Typedef - still needs more attention
parent 6d94d8ed
......@@ -8,40 +8,52 @@ s?^License.*?\*\/\
}
# remove entry
/^Primitive/{
/^Primitive *$/{
N
N
d
}
# remove entry
/^Implementation/{
/^Implementation *$/{
N
N
d
}
# remove entry
/^Application/{
/^Application *$/{
N
N
d
}
# remove entry
/^Type/{
/^Type *$/{
N
N
d
}
# remove entry
/^Global/{
/^Global *$/{
N
N
d
}
# Class
# Foam::className
# =>
# @class Foam::className
#
/^Class *$/,/^[^ ]/{
/^Class/d
s/^ /@class /
}
# Namespace
# namespaceName
# =>
......@@ -53,14 +65,14 @@ s/^ /@namespace /
}
# Class
# Foam::className
# Typedef
# Foam::def
# =>
# @class Foam::className
# @typedef Foam::def
#
/^Class *$/,/^[^ ]/{
/^Class/d
s/^ /@class /
/^Typedef *$/,/^[^ ]/{
/^Typedef/d
s/^ /@typedef /
}
......
body { color: #000000 ; background: #ffffff; margin: 0px; font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; font-size: 12px; }
a:link { text-decoration: none; color: #0000ff ; }
a:link:hover { text-decoration: none; color: #0000ff ; }
a:visited { text-decoration: none; color: #0000ff ; }
a:visited:hover { text-decoration: none; color: #0000ff ; }
a:link img { border: 0; }
a:visited img { border: 0; }
a:active img { border: 0; }
a.menuLefton { color: #0000ff; font-size: 12px; font-weight: bold; }
td.leftmenu { font-family: verdana, arial, helvetica, sans-serif; text-decoration: none; background: #ddddff; text-align: left; font-size: 14px; height: 20px; width: 200px; }
a.menuTopoff { color: #000000; font-size: 14px; }
a.menuTopoff:visited { color: #000000; font-size: 14px; }
a.menuTopoff:hover { color: #0000ff; font-size: 14px; }
td.topmenu { font-family: verdana, arial, helvetica, sans-serif; background: #ddddff; text-align: center; font-size: 16px; width: 150px; font-weight: bold; }
h1 { font-size: 18px; }
h2 { font-size: 16px; }
h3 { font-size: 14px; }
/* formatting for member functions:
* Since the OpenFOAM code already has nice line-breaks, wrapping the lines
* just looks terrible.
* Give a slightly different background to make it easier to find.
*/
.memitem {
padding: 4px;
background-color: #eef3f5;
border-width: 1px;
border-style: solid;
border-color: #dedeee;
}
.memproto {
background-color: #d5e1e8;
width: 100%;
border-width: 1px;
border-style: solid;
border-color: #84b0c7;
font-weight: bold;
}
table.memname {
width: 100%;
background: #f7f7ff;
white-space: nowrap;
}
.mdescLeft {
margin: 0px;
}
.mdescRight {
font-style: italic;
}
.paramkey {
width: 5%;
}
\ No newline at end of file
......@@ -5,6 +5,7 @@ See the comments in the scripts.
2. fix-Class
3. find-tinyDescription
4. find-placeholderDescription
5. find-retagged
Misc Tools
1. find-templateInComments
......
......@@ -39,7 +39,6 @@ sub wanted {
close ARGV;
}
## Traverse desired filesystems
for my $dir (@ARGV) {
no warnings 'File::Find';
......
......@@ -8,7 +8,7 @@ use File::Find ();
# find-placeholderDescription
#
# Description
# Search for *.[H] files with a Description that looks like it is
# Search for *.[H] files with a Description that looks like it is
# a placeholder
# eg, Foam::className
#
......@@ -30,21 +30,21 @@ sub wanted {
return;
}
my ( $currentClass, $description );
my ( $tag, $description );
local @ARGV = $_;
while (<>) {
my $name;
## examine the class name
if (/^Class\s*$/) {
## examine the class/typedef name
if (/^(Class|Typedef)\s*$/) {
$_ = <>;
($currentClass) = split;
($tag) = split;
}
if (/^Description\s*$/) {
$_ = <>;
( $description = $_ ) =~ s{^\s+|\s+$}{}g;
# remove trailing punctuation as being noise
$description =~ s{\s*[.,:]+$}{};
last;
......@@ -53,13 +53,13 @@ sub wanted {
$description ||= '';
## we have 'Class' tag
if ( defined $currentClass ) {
## we have 'Class/Typedef' tag
if ( defined $tag ) {
# description looks like a class name
if (
$description =~ m{^\w+(::\w+)+$}
) {
print "$File::Find::name # $description\n";
) {
print "$File::Find::name # $description\n";
}
}
}
......
#!/usr/bin/perl -w
use strict;
use File::Find ();
# -----------------------------------------------------------------------------
#
# Script
# find-retagged
#
# Description
# Search for *.[H] files with 'InClass', 'InNamespace' or 'Type'
# starting in the first column.
# In some places these could removed. In other places they should be
# replaced with a 'Typedef'
# - print filename and the tag (InClass|InNamespace|Type)
#
# -----------------------------------------------------------------------------
my $re_filespec = qr{^.+\.[H]$};
# for the convenience of &wanted calls, including -eval statements:
## use vars qw( *name *dir *prune );
## *name = *File::Find::name;
## *dir = *File::Find::dir;
## *prune = *File::Find::prune;
sub wanted {
unless ( lstat($_) and -f _ and -r _ and not -l _ and /$re_filespec/ ) {
return;
}
local @ARGV = $_;
while (<>) {
if (/^(InClass|InNamespace|Type)\s*$/) {
print "$File::Find::name $1 line=$.\n";
}
}
close ARGV;
}
## Traverse desired filesystems
for my $dir (@ARGV) {
no warnings 'File::Find';
warn "(**) checking '$dir' ...\n";
File::Find::find( { wanted => \&wanted }, $dir );
}
......@@ -28,7 +28,7 @@ Class
Description
A HashTable with word keys but without contents.
Class
Typedef
Foam::wordHashSet
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Typedef
Foam::labelHashSet
Description
......
......@@ -26,14 +26,14 @@ Class
Foam::IOstream
Description
An IOstream is an abstract base class for all input/output
systems; be they streams, files, token lists etc.
The basic operations are construct, close, read token,
read primitive and read binary block. In addition version control
and line number counting is incorporated. Usually one would use
the read primitive member functions, but if one were reading a
stream on unknown data sequence one can read token by token, and
then analyse.
An IOstream is an abstract base class for all input/output systems; be
they streams, files, token lists etc.
The basic operations are construct, close, read token, read primitive
and read binary block. In addition version control and line number
counting is incorporated. Usually one would use the read primitive
member functions, but if one were reading a stream on unknown data
sequence one can read token by token, and then analyse.
SourceFiles
IOprint.C
......
......@@ -154,7 +154,7 @@ public:
//- Flush stream
virtual void flush() = 0;
//- Add '\n' and flush stream
//- Add newline and flush stream
virtual void endl() = 0;
//- Get width of output field
......@@ -233,7 +233,7 @@ inline Ostream& flush(Ostream& os)
}
//- Add '\n' and flush stream
//- Add newline and flush stream
inline Ostream& endl(Ostream& os)
{
os.endl();
......
......@@ -22,11 +22,17 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Foam::complexFields
Typedef
Foam::complexField
Description
Specialisation of Field\<T\> for complex and complexVector.
Specialisation of Field\<T\> for complex.
Typedef
Foam::complexVectorField
Description
Specialisation of Field\<T\> for complexVector.
SourceFiles
complexFields.C
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::diagTensorField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::labelField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::scalarField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::sphericalTensorField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::symmTensorField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::symmTransformField
Description
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::tensorField
Description
......
......@@ -22,11 +22,8 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Foam::vector2DField
Description
Specialisation of Field\<T\> for vector2D.
Foam::vector2DField
SourceFiles
vector2DField.C
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
InClass
Typedef
Foam::vector2DField
Description
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment