Re: undocumented signals

[Owen Taylor <otaylor redhat com>]

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?

-          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{}?

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

Other than that, looks reasonable.

Regards,
                                        Owen