Re: /*< private >*/ handling

[Damon Chaplin <damon kendo fsnet co uk>]

On Mon, 2002-12-02 at 23:27, Matthias Clasen wrote:
> Should I interpret no comments as silent approval and commit this ?


Index: gtkdoc-mkdb.in
===================================================================
RCS file: /cvs/gnome/gtk-doc/gtkdoc-mkdb.in,v
retrieving revision 1.62
diff -u -b -B -p -r1.62 gtkdoc-mkdb.in
--- gtkdoc-mkdb.in	12 Nov 2002 10:21:27 -0000	1.62
+++ gtkdoc-mkdb.in	25 Nov 2002 23:29:34 -0000
@@ -686,7 +686,7 @@ sub OutputStruct {
     my ($symbol, $declaration) = @_;
 
     my $is_widget_struct = 0;
-    if (&CheckIsObject ($symbol)) {
+    if (&CheckIsObject ($symbol) || ($symbol =~ /^(\S+)Class/)) {
 #	print "Found widget struct: $symbol\n";
 	$is_widget_struct = 1;
     }

I'm not sure you should set $is_widget_struct to 1 for the Class
structs. That will change the SGML ID that is used to link to them,
just after this code. i.e. you'd need to update links to
"GtkButtonClass" to "GtkButtonClass_struct".

I'd say use an additional flag, e.g. $remove_private_fields.

    if (&CheckIsObject ($symbol)) {
#	print "Found widget struct: $symbol\n";
	$is_widget_struct = 1;
        $remove_private_fields = 1;
    }
    if ($symbol =~ /^(\S+)Class/) {
	$remove_private_fields = 1;
    }



Index: gtkdoc-scan.in
===================================================================
RCS file: /cvs/gnome/gtk-doc/gtkdoc-scan.in,v
retrieving revision 1.20
diff -u -b -B -p -r1.20 gtkdoc-scan.in
--- gtkdoc-scan.in	23 Jan 2002 23:42:57 -0000	1.20
+++ gtkdoc-scan.in	25 Nov 2002 23:29:34 -0000
@@ -483,16 +483,14 @@ sub ScanHeader {
 		if ($symbol =~ m/^(\S+)Class/
                     && $1 ne 'GtkStyle' && $1 !~ /^(Pango|Bonobo)/) {
 #		    print "Found object: $1\n";
-		    $list .= "<TITLE>$1</TITLE>\n";
 		    push (@objects, $1);

It would probably be better to still output the <TITLE> line for widget
classes found. It is possible that changing it could break something :)
(Though this is only relevant when first setting up the docs for a
library.)

Damon