[Offscreengecko-commits] SF.net SVN: offscreengecko:[98] trunk

[<re...@us...>]

Revision: 98
          http://offscreengecko.svn.sourceforge.net/offscreengecko/?rev=98&view=rev
Author:   res2002
Date:     2008-11-02 17:16:36 +0000 (Sun, 02 Nov 2008)

Log Message:
-----------
Documentation tweaks

Modified Paths:
--------------
    trunk/docs/api.dox
    trunk/include/OffscreenGecko/baseobj.h
    trunk/include/OffscreenGecko/browser.h

Added Paths:
-----------
    trunk/src/demos/doxygen_samples

Modified: trunk/docs/api.dox
===================================================================
--- trunk/docs/api.dox	2008-11-02 16:37:36 UTC (rev 97)
+++ trunk/docs/api.dox	2008-11-02 17:16:36 UTC (rev 98)
@@ -136,7 +136,7 @@
 # comments will behave just like regular Qt-style comments 
 # (thus requiring an explicit @brief command for a brief description.)
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
 # interpret the first line (until the first dot) of a Qt-style 
@@ -360,7 +360,7 @@
 # by member name. If set to NO (the default) the members will appear in 
 # declaration order.
 
-SORT_BRIEF_DOCS        = NO
+SORT_BRIEF_DOCS        = YES
 
 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
 # sorted by fully-qualified names, including namespaces. If set to 
@@ -493,7 +493,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = include/
+INPUT                  = include/ src/demos/doxygen_samples
 
 # This tag can be used to specify the character encoding of the source files that 
 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
@@ -548,7 +548,7 @@
 # directories that contain example code fragments that are included (see 
 # the \include command).
 
-EXAMPLE_PATH           = 
+EXAMPLE_PATH           = $(TOP)/src/demos/
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -673,7 +673,7 @@
 # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
 # should be ignored while generating the index headers.
 
-IGNORE_PREFIX          = 
+IGNORE_PREFIX          = osgk_
 
 #---------------------------------------------------------------------------
 # configuration options related to the HTML output

Modified: trunk/include/OffscreenGecko/baseobj.h
===================================================================
--- trunk/include/OffscreenGecko/baseobj.h	2008-11-02 16:37:36 UTC (rev 97)
+++ trunk/include/OffscreenGecko/baseobj.h	2008-11-02 17:16:36 UTC (rev 98)
@@ -54,6 +54,9 @@
  *
  * If you're programming in C++ instead, you might be more interested in
  * <a href="annotated.html">the class list</a>.
+ *
+ * <em>Examples</em> can be found in the
+ * <a href="pages.html">Related Pages section</a>.
  */
 
 /**\page Basics OffscreenGecko object basics
@@ -88,12 +91,12 @@
  * \section BasicsCXX Dealing with OffscreenGecko objects (C++)
  * The OffscreenGecko C++ interface wraps all OffscreenGecko objects into C++
  * classes; so instead of calling a function and passing in the opaque object
- * pointer you can directly a method on the object. Furthermore, reference
+ * pointer you can directly call a method on the object. Furthermore, reference
  * counting is handled automatically when an object is created, destroyed,
  * copied etc.
  *
  * However, to use these classes efficiently, an implementation detail must be
- * noted: the classes merely wrap the opaque pointers from the C interface.
+ * noted: the C++ classes merely wrap the opaque pointers from the C interface.
  * This has several implications:
  * - A copy is not a true copy - the "copy" is merely an additional reference
  *   to the same object as the original.
@@ -102,26 +105,18 @@
  * In that sense, the wrapper classes have a behaviour that more resembles Java
  * references to classes than "true" C++ inlined classes.
  *
- * An instance of the wrapped object is created immediately when the wrapper
- * class is constructed. Delayed creation is still possible, though: for that,
- * the wrapper must be initialized with a <i>null reference</i>. Later, a new
- * instance of the wrapper for the desired object can be assigned. Example:
- * \code
- * // Initializes as a "null reference"
- * OSGK::Browser myBrowser (OSGK::Browser::Null());
- *
- * // ... do other stuff ...
- *
- * // Now actually create an object
- * myBrowser = OSGK::Browser (...);
- * \endcode
+ * In C++, an instance of the wrapped object type is created immediately when 
+ * the wrapper class is constructed. Delayed creation is still possible, 
+ * though: for that, the wrapper must be initialized with a <i>null reference</i>. 
+ * Later, a new instance of the wrapper type for the desired object can be assigned. 
+ * For example code see \ref example_delayedcreation.
  */
-
+ 
 /**
  * Base OffscreenGecko object. All other types derive from this.
  * @{
  */
-struct OSGK_BaseObject_s
+typedef struct OSGK_BaseObject_s
 {
 #ifdef OSGK_BUILD
   ///\internal Object reference count
@@ -131,8 +126,8 @@
   int reserved;
 # endif
 #endif
-};
-typedef struct OSGK_BaseObject_s OSGK_BaseObject;
+}
+OSGK_BaseObject;
 /** @} */
 
 #define OSGK_DERIVEDTYPE(T)           \
@@ -182,6 +177,10 @@
       /// Wrapped object
       T* obj;
     public:
+      /**
+       * Return a <i>null instance</i> of the wrapped object type.
+       * Useful when creating objects in a delayed fashion.
+       */
       static WrappedType* Null() { return 0; }
     
       /// Construct with taking ownership of a given object.

Modified: trunk/include/OffscreenGecko/browser.h
===================================================================
--- trunk/include/OffscreenGecko/browser.h	2008-11-02 16:37:36 UTC (rev 97)
+++ trunk/include/OffscreenGecko/browser.h	2008-11-02 17:16:36 UTC (rev 98)
@@ -273,7 +273,7 @@
   /**
    * Allow subpixel antialiasing (aka ClearType). This should only be used
    * when it's known that a surface pixel will exactly match an LCD pixel. If
-   * that's not the case output will jave color fringes.
+   * that's not the case output will have color fringes.
    */
   aaSubpixel
 } OSGK_AntiAliasType;

Added: trunk/src/demos/doxygen_samples
===================================================================
--- trunk/src/demos/doxygen_samples	                        (rev 0)
+++ trunk/src/demos/doxygen_samples	2008-11-02 17:16:36 UTC (rev 98)
@@ -0,0 +1,30 @@
+/**\file
+ * This is just a dummy container for the doxygen markup for the examples.
+ * The list of examples can be found in the <a href="pages.html">Related Pages section</a>.
+ */
+
+/** \page example_delayedcreation Example: Delayed creation of an OffscreenGecko object in C++
+ * In C++, an instance of the wrapped object type is created immediately when 
+ * the wrapper class is constructed. Delayed creation is still possible, 
+ * though: for that, the wrapper must be initialized with a <i>null reference</i>. 
+ * Later, a new instance of the wrapper type for the desired object can be assigned. 
+ * \code
+ * // Initializes as a "null reference"
+ * OSGK::Browser myBrowser (OSGK::Browser::Null());
+ *
+ * // ... do other stuff ...
+ *
+ * // Now actually create an object
+ * myBrowser = OSGK::Browser (...);
+ * \endcode
+ */
+
+/**
+ * \page example_web2image Example: Render web page to image file
+ * This is a simple application that renders a web page to a memory buffer
+ * and writes that to disk.
+ *
+ * (OSGK::TGAWriter is an OffscreenGecko-internal class; but the image 
+ * writing is not the point of the example anyway.)
+ * \include webpage2image.cpp
+ */
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.