Re: undocumented signals

[Matthias Clasen <maclas gmx de>]

On Tue, 2003-05-27 at 04:51, Owen Taylor wrote:
> On Mon, 2003-05-26 at 18:12, Matthias Clasen wrote:
> > Here is a patch to make gtk-doc include signals and properties in the
> > total number of symbols, and also list them in $MODULE-undocumented.txt
> > if they're undocumented. This was requested by Owen in
> > http://bugzilla.gnome.org/show_bug.cgi?id=113645.
> > The patch doesn't change the generated docs at all, only the reported
> > statistics.
> 
> +               if ($SymbolDocs{$symbol} !~ /<para>\s*<\/para>/) {
> 
> This means "the docs don't contain an empty paragraph", since the
> match is unanchored.
> 
> Maybe 
>  
>  ... !~ /^\s*<para>\s*</para>/\s*$/) {
> 
> ? Seems though that this is an existing bug, since we later have:
> 
>                !($SymbolDocs{$symbol} =~ "<para>\n(FIXME)?\n</para>")) {
>                 $blurb = &ExpandAbbreviations($SymbolDocs{$symbol});
> +               $AllDocumentedSymbols{$symbol} = 1;
>             }
> 
> possibly a "IsEmptyDoc" helper function would be useful?

Yes. 

> 
> -          if (defined ($Declarations{$symbol})) {
> +          if (defined ($Declarations{$symbol}) ||
> +             ($symbol !~
> /.*:(Title|Long_Description|Short_Description|See_Also)/)) {
> 
> Is the defined ($Declarations($symbol)) still needed here? I
> assume that Title,Long_Description, and so forth would never
> appear in Declartions{}?
> 

You're right.

> The unanchored .* at the beginning doesn't actually add any content.

Ok. (Perl isn't my native language...)

> 
> Other than that, looks reasonable.

Committed with the changes above.

Matthias