GNOME.org
 

[gstreamermm] Refine the Doxygen main page.

commit fc0b7e71f9916035724eb8e1584e4aaedafd33a0
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Mon May 24 15:10:31 2010 -0400

    	Refine the Doxygen main page.
    
    	* gstreamer/gstreamermm.h:
    	- Include references to main classes that users might want to know
    	  about.
    	- Make the features a list instead of a paragraph.
    	- Include a paragraph about initializing the library and a reference
    	  to the GStreamer Application Development Manual.
    	- Use caps for section names so that it looks nice in the web pages.
    	  Apparently, this makes Doxygen use the section title instead of the
    	  name.
    	* docs/reference/Doxyfile.in: Use options from gtkmm for consistency.
    	* README: Typos.

 ChangeLog                  |   16 ++++++++++++++++
 README                     |    2 +-
 docs/reference/Doxyfile.in |   17 ++++++++++-------
 gstreamer/gstreamermm.h    |   30 ++++++++++++++++++++----------
 4 files changed, 47 insertions(+), 18 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 8d9f848..b99067e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,19 @@
+2010-05-24  José Alburquerque  <jaalburqu svn gnome org>
+
+	Refine the Doxygen main page.
+
+	* gstreamer/gstreamermm.h:
+	- Include references to main classes that users might want to know
+	  about.
+	- Make the features a list instead of a paragraph.
+	- Include a paragraph about initializing the library and a reference
+	  to the GStreamer Application Development Manual.
+	- Use caps for section names so that it looks nice in the web pages.
+	  Apparently, this makes Doxygen use the section title instead of the
+	  name.
+	* docs/reference/Doxyfile.in: Use options from gtkmm for consistency.
+	* README: Typos.
+
 0.10.7.1:
 
 2010-05-23  José Alburquerque  <jaalburqu svn gnome org>
diff --git a/README b/README
index 55a4b39..2c79519 100644
--- a/README
+++ b/README
@@ -8,7 +8,7 @@ develop applications that work with multimedia in C++.
 gstreamermm is developed over glibmm, libsigc++ and libxml++ and the
 functionalities they provide.  This means that, among other things, referencing
 and unreferencing of GObjects is handled automatically via glibmm's automatic
-pointer class, Glib:RefPtr<>, and libsigc++'s slots are used for callbacks and
+pointer class, Glib::RefPtr, and libsigc++'s slots are used for callbacks and
 signals.
 
 There are several examples, including a media player, in the examples/
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index cdfa426..cd7eb88 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -1,4 +1,4 @@
-# Doxyfile 1.5.8
+# Doxyfile 1.6.1
 # @configure_input@
 
 #---------------------------------------------------------------------------
@@ -54,7 +54,7 @@ EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = NO
 EXTRACT_LOCAL_METHODS  = NO
 EXTRACT_ANON_NSPACES   = NO
-HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_MEMBERS     = NO
 HIDE_UNDOC_CLASSES     = YES
 HIDE_FRIEND_COMPOUNDS  = YES
 HIDE_IN_BODY_DOCS      = YES
@@ -65,6 +65,7 @@ SHOW_INCLUDE_FILES     = NO
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
 SORT_BRIEF_DOCS        = NO
+SORT_MEMBERS_CTORS_1ST = YES
 SORT_GROUP_NAMES       = YES
 SORT_BY_SCOPE_NAME     = YES
 GENERATE_TODOLIST      = NO
@@ -130,7 +131,7 @@ VERBATIM_HEADERS       = NO
 #---------------------------------------------------------------------------
 # configuration options related to the alphabetical class index
 #---------------------------------------------------------------------------
-ALPHABETICAL_INDEX     = NO
+ALPHABETICAL_INDEX     = YES
 COLS_IN_ALPHA_INDEX    = 5
 IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
@@ -165,8 +166,10 @@ QHG_LOCATION           =
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 1
 GENERATE_TREEVIEW      = NONE
+USE_INLINE_TREES       = NO
 TREEVIEW_WIDTH         = 250
 FORMULA_FONTSIZE       = 10
+SEARCHENGINE           = NO
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
@@ -182,6 +185,7 @@ PDF_HYPERLINKS         = YES
 USE_PDFLATEX           = YES
 LATEX_BATCHMODE        = NO
 LATEX_HIDE_INDICES     = NO
+LATEX_SOURCE_CODE      = NO
 #---------------------------------------------------------------------------
 # configuration options related to the RTF output
 #---------------------------------------------------------------------------
@@ -230,6 +234,9 @@ INCLUDE_FILE_PATTERNS  = *.h
 PREDEFINED             = __cplusplus \
                          DOXYGEN_SHOULD_SKIP_THIS \
                          "G_GNUC_CONST=" \
+                         "G_GNUC_NORETURN=" \
+                         "G_GNUC_NULL_TERMINATED=" \
+                         "G_GNUC_PURE=" \
                          "GSTREAMERMM_API=" \
                          GLIBMM_VFUNCS_ENABLED \
                          GLIBMM_PROPERTIES_ENABLED \
@@ -277,7 +284,3 @@ DOT_TRANSPARENT        = NO
 DOT_MULTI_TARGETS      = YES
 GENERATE_LEGEND        = YES
 DOT_CLEANUP            = YES
-#---------------------------------------------------------------------------
-# Options related to the search engine
-#---------------------------------------------------------------------------
-SEARCHENGINE           = NO
diff --git a/gstreamer/gstreamermm.h b/gstreamer/gstreamermm.h
index 29b8253..e7e1691 100644
--- a/gstreamer/gstreamermm.h
+++ b/gstreamer/gstreamermm.h
@@ -3,33 +3,43 @@
 
 /** @mainpage gstreamermm Reference Manual
  *
- * @section description Description
+ * @section Description Description
  *
  * gstreamermm provides C++ bindings for the <a
  * href="http://gstreamer.freedesktop.org";>GStreamer streaming multimedia
  * library</a>.  With gstreamermm it is possible to develop applications that
- * work with multimedia in C++.
+ * work with multimedia in C++.  For instance, see Gst::Element, Gst::Bin and
+ * Gst::Pipeline.
  *
- * @section features Features
+ * @section Features Features
  *
- * gstreamermm is developed over <a
+ * - gstreamermm is developed over <a
  * href="http://www.gtkmm.org/index.shtml";>glibmm</a>, <a
  * href="http://libsigc.sourceforge.net/";>libsigc++</a> and <a
  * href="http://libxmlplusplus.sourceforge.net/";>libxml++</a> and the
- * functionalities they provide.  This means that, among other things,
- * referencing and unreferencing of GObjects is handled automatically via
- * glibmm's automatic pointer class, Glib:RefPtr<>, and libsigc++'s slots are
- * used for callbacks and signals.
+ * functionalities they provide.
+ * - Referencing and unreferencing of GObjects is handled automatically via
+ *  glibmm's automatic pointer class, Glib::RefPtr.
+ * - libsigc++'s slots are used for callbacks and signals.
+ * - Many of the GStreamer core and base plug-ins are wrapped.
  *
- * @section basics Basic Usage
+ * @section Basics Basic Usage
  *
- * Include the gstreamermm header:
+ * To use the library, some form of the Gst::init() method must be called
+ * before using its classes, functions, etc.  To get a deeper understanding of
+ * how to set up pipelines, deal with elements, pads, etc., see the <a
+ * href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/manual/html/index.html";>GStreamer
+ * Application Development Manual</a>.
+ *
+ * The following includes the gstreamermm header:
  * @code
  * #include <gstreamermm.h>
  * @endcode
  * (You may include individual headers, such as @c gstreamermm/pipeline.h
  * instead.)
  *
+ * @section Compiling Compiling
+ *
  * If your source file is @c program.cc, you can compile it with:
  * @code
  * g++ program.cc -o program  `pkg-config --cflags --libs gstreamermm-0.10`
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]