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

Doxygen cleanups

Browse Source 
* 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
This commit is contained in:
Mark Olesen
2008-06-11 10:05:33 +02:00
parent 6d94d8ed8b
commit e5f0dd3e03
37 changed files with 190 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/Doxygen/tools/find-placeholderDescription
View File

@ -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";
}
}
}