Release 0.90.3

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

diff --git a/doc/gob.1.in b/doc/gob.1.in
index ee42dd9d513f411bd20f384786ef6313aa803d0e..82f31ab325951e34259c099c61c28f8243d0d951 100644 (file)
--- a/doc/gob.1.in
+++ b/doc/gob.1.in
@@ -181,7 +181,8 @@ so that one can override the method in derived methods.  They can be empty
 which makes calling the methods he same as public methods.  This type of
 method is just a little bit "slower" then normal functions, but not as
 slow as signals.  You define them by using "virtual" keyword before the
 which makes calling the methods he same as public methods.  This type of
 method is just a little bit "slower" then normal functions, but not as
 slow as signals.  You define them by using "virtual" keyword before the

-prototype.
+prototype. If you put the keyword "private" right after the "virtual"
+keyword, the wrapper will not be a public method, but a private one.

 .PP
 Signals:
 .PP
 .PP
 Signals:
 .PP


@@ -214,6 +215,13 @@ or
 
 .fi
 .PP
 
 .fi
 .PP

+If you don't want the wrapper that emits the signal to be public, you can
+include the keyword "private" after the "signal" keyword. This will make
+the wrapper a normal private method.
+.PP
+If you don't define a "first" or a "last", the default will be taken as
+"last".
+.PP

 Override methods:
 .PP
 If you need to override some method (a signal or a virtual method
 Override methods:
 .PP
 If you need to override some method (a signal or a virtual method


@@ -271,8 +279,23 @@ will fetch a new object, so a fairly standard new method would look like:
 .SH BUGS
 .PP
 The generated header file is included as the first file in the .c file, no
 .SH BUGS
 .PP
 The generated header file is included as the first file in the .c file, no

-matter what. This means that you will have to put things that need to be included
-before that, into an %h{ } section.
+matter what. This means that you will have to put things that need to be
+included before that, into an %h{ } section.
+.PP
+Also the lexer does not actually parse the C code, so I'm sure that some corner
+cases or maybe even some not so corner cases of C syntax might confuse gob
+completely.  If you find any, send me the source that makes it go gaga and I'll
+try to make the lexer try to handle it properly, but no promises.
+.PP
+Gob uses a lot of #define's so sometimes it can confuse your code.  One way
+to make sure you don't get confused is not to use method names for absolutely
+anything else since gob will use defines of the type:
+.nf
+
+  #define method_name class_name_method_name
+
+.fi
+For your class code.

 
 .SH AUTHOR
 .PP
 
 .SH AUTHOR
 .PP