aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVsevolod Stakhov <vsevolod@highsecure.ru>2018-12-10 13:06:54 +0000
committerVsevolod Stakhov <vsevolod@highsecure.ru>2018-12-10 13:06:54 +0000
commit41d03831084fa8ae24c2b153244e2677cd9fde42 (patch)
tree1ecd47f69bc79143b40667d75f30e679649b7e4d
parent525f1dc2c1bf5c18dbcddf1a67549f6c01f9623f (diff)
downloadrspamd-41d03831084fa8ae24c2b153244e2677cd9fde42.tar.gz
rspamd-41d03831084fa8ae24c2b153244e2677cd9fde42.zip
[Doc] Improve doxydown methods/functions index
-rwxr-xr-xdoc/doxydown/doxydown.pl15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/doxydown/doxydown.pl b/doc/doxydown/doxydown.pl
index d58d4a906..85821da4d 100755
--- a/doc/doxydown/doxydown.pl
+++ b/doc/doxydown/doxydown.pl
@@ -339,15 +339,15 @@ sub parse_function {
if ( /^\s*\@param\s*(?:\{([^}]+)\})?\s*(\S+)\s*(.+)?\s*$/ ) {
my $p = {
name => $2,
- type => $1,
- description => $3
+ type => $1 || "no type",
+ description => $3 || "no description"
};
push @{ $f->{'params'} }, $p;
} elsif ( /^\s*\@return\s*(?:\{([^}]+)\})?\s*(.+)?\s*$/ ) {
my $r = {
type => $1,
- description => $2
+ description => $2 || "no description"
};
push @{ $f->{'returns'} }, $r;
@@ -379,6 +379,15 @@ sub parse_function {
chomp $f->{'example'};
}
+ if ( !$f->{'brief'} && $f->{'data'} ) {
+ $f->{'data'} =~ /^([^.]+)\.?.*/;
+
+ if ( $1 ) {
+ $f->{'brief'} = "$1.";
+ chomp $f->{'brief'};
+ }
+ }
+
if ( $type eq "method" ) {
push @{ $cur_module->{'methods'} }, $f;
} elsif ( $type eq "function" || $type eq "fn") {