Release 0.90.5

[gob-dx.git] / doc / gob.1.in

diff --git a/doc/gob.1.in b/doc/gob.1.in
index 7691736c75a578f90001a4a9dc8d696766020d83..426858045c287bc9e28fee27b6caf0723ac29072 100644 (file)
--- a/doc/gob.1.in
+++ b/doc/gob.1.in
@@ -45,19 +45,26 @@ so it is not enabled by default.
 
 .SH TYPENAMES
 .PP
-Because we need to parse out different parts of the typename, 
-sometimes you need to specify the typename with some special syntax.
-Types are specified in capitalized form and words are separated by ':'.
-The first word of the type (which can be empty) is the "namespace".  This
-fact is for example used for the type checking macro.  For "Gtk:New:Button",
-the macro will be GTK_IS_NEW_BUTTON.  This format of typenames is used in
-the class declaration header and for method argument types.
+Because we need to parse out different parts of the typename, sometimes you
+need to specify the typename with some special syntax.  Types are specified in
+capitalized form and words are separated by ':'.  The first word of the type
+(which can be empty) is the "namespace".  This fact is for example used for the
+type checking macro and the type macro.  For "Gtk:New:Button", the macros will
+be GTK_IS_NEW_BUTTON and GTK_TYPE_NEW_BUTTON.  This colon separated format of
+typenames is used in the class declaration header and for method argument
+types.
 
-.SH OUTPUT FILE NAMES
+.SH OUTPUT FILES
 .PP
 The filenames are created from the typename.  The words are
 separated by '-' and all in lower case.  For example for an object named
 "Gtk:New:Button", the files are gtk-new-button.c and gtk-new-button.h.
+The header file is created to be human readable and to be used as a
+reference to the object.  The .c source file is not created as a human
+readable source and is littered with #line statements, which make the
+compiler attempt to point you to the right line in your .gob file in
+case of parsing errors.  The output should not be editted by hand, and
+you should only edit the .gob file.
 
 .SH INCLUDING NORMAL C CODE IN THE OUTPUT FILES
 .PP
@@ -259,13 +266,15 @@ override method.  After the "override" keyword, you should put the
 typename of the class you are overriding a method from.  Other then that
 it is the same as for other methods.  The "self" pointer in this case
 should be the type of the method you are overriding so that you don't
-get warnings during compilation.  Example:
+get warnings during compilation.  Also to call the method of the parent
+class, you can use the PARENT_HANDLER macro with your arguments.  Example:
 .nf
 
   override (Gtk:Container) void
   add (Gtk:Container *self (check null type), Gtk:Widget *wid (check null type))
   {
-         ...
+          /* some code here */
+          PARENT_HANDLER(self, wid);
   }
 .fi
 .PP