]> git.draconx.ca Git - gob-dx.git/blobdiff - doc/gob2.1.in
Release 2.0.8
[gob-dx.git] / doc / gob2.1.in
index c6b523e3845de13b86d02024165a32fa7e65b73f..67c6f55d89aa7c967c540add399bbe716398122e 100644 (file)
@@ -59,11 +59,11 @@ unchanged however.
 .TP
 .B --always-private-header
 Always create a \fB<basename>-private.h\fR file, even if it would be empty.
-This is the default.
 .TP
 .B --ondemand-private-header
 Create the private header only if it would have something in it, that is,
 if there are some private data members or protected methods.
+This is the default.
 .TP
 .B --no-private-header
 Never create a private header file.  If we use any private data members,
@@ -91,9 +91,12 @@ and SELF_CLASS macros.
 Do not remove the initial underscore from method names.
 .TP
 .B --always-private-struct
-Always include the private pointer in the public header file.  This is useful for
-files which are part of a library and you want to reserve the right to add some
-private data members without breaking binary compatibility.
+Always include the private pointer in the public header file.  This is useful
+for files which are part of a library and you want to reserve the right to add
+some private data members without breaking binary compatibility.
+.TP
+.B -o --output-dir
+The directory into which output should be placed.
 
 .SH TYPENAMES
 .PP
@@ -206,7 +209,7 @@ For example:
 
 .SH DATA MEMBERS
 .PP
-There are five types of data members.  Three of them are normal data numbers,
+There are five types of data members.  Three of them are normal data members,
 one is class wide (global) in scope and one is a virtual one, usually linked to
 a normal data member or a class wide data member.  The three normal data
 members are public, protected and private.  Public and protected are basically
@@ -808,9 +811,9 @@ your .c file.  These serve the same function as the above, they make it easier
 to type and easier to change typenames around which can help a lot during
 prototyping stage.  However you should note that the Self type should not be
 used in function prototypes as one of the arguments or as a return value type.
-This is because this is a simple C typedef which is only available inside you
-.c file.  You can disable both the self casting macros and the self type
-aliases by passing --no-self-alias to
+This is because this is a simple C typedef which is only available inside your
+\&.c file and not in the header files.  You can disable both the self casting
+macros and the self type aliases by passing --no-self-alias to gob.
 
 .SH DEALING WITH DIFFERENT GOB VERSIONS
 .PP
@@ -1109,7 +1112,7 @@ check for GOB2 in your configure.in file.  You can use the supplied m4 macro
 which will also check the version of gob.  Basically you include this:
 .nf
 
-  GOB2_CHECK(2.0.0)
+  GOB2_CHECK([2.0.0])
 
 .fi
 This will replace @GOB2@ in your makefiles with the full path of gob2.  Thus