GNOME.org
 

[libgda-uimm] Add a main page to the Doxygen documentation.

commit 193bbc0adc6c630c11cccd2800ab5c807c487f9f
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Sun May 9 16:56:39 2010 -0400

    	Add a main page to the Doxygen documentation.
    
    	* README: Correct the general information so that it can also be used
    	for the main page.
    	* docs/Makefile.am: Add libgda-uimm.h to the list of files to be
    	processed for documentation because the Doxygen main page will be
    	contained there.
    	* docs/reference/Doxyfile.in: Make the options coincide with the
    	glibmm options.
    	* libgda-ui/libgda-uimm.h: Add the main page.

 ChangeLog                  |   13 +++++++++++++
 README                     |    5 +++--
 docs/Makefile.am           |    4 ++--
 docs/reference/Doxyfile.in |   35 +++++++++++++++++++++--------------
 libgda-ui/libgda-uimm.h    |   39 ++++++++++++++++++++++++++++++++++++++-
 5 files changed, 77 insertions(+), 19 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 520941d..1602afe 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2010-05-09  José Alburquerque  <jaalburqu svn gnome org>
+
+	Add a main page to the Doxygen documentation.
+
+	* README: Correct the general information so that it can also be used
+	for the main page.
+	* docs/Makefile.am: Add libgda-uimm.h to the list of files to be
+	processed for documentation because the Doxygen main page will be
+	contained there.
+	* docs/reference/Doxyfile.in: Make the options coincide with the
+	glibmm options.
+	* libgda-ui/libgda-uimm.h: Add the main page.
+
 2010-04-29  José Alburquerque  <jaalburqu svn gnome org>
 
 	Update the required version of libgda and libgda-ui.
diff --git a/README b/README
index d635c87..b84c2c5 100644
--- a/README
+++ b/README
@@ -1,8 +1,9 @@
 General Information:
 -------------------
 
-Libgda-uimm wraps libgda-ui, ui components based on Gtk+ for libgda, the gnome
-database access library.  Libgda-uimm wraps the libgda-ui widgets using gtkmm.
+libgda-uimm is a C++ wrapper for libgda-ui, a library of ui widgets based on
+GTK+ for libgda, the gnome database access library.  libgda-uimm wraps the
+libgda-ui widgets using gtkmm.
 
 For more information see the gtkmm home page, http://www.gtkmm.org.  Also,
 questions may be asked on the gtkmm list, gtkmm-list gnome org 
diff --git a/docs/Makefile.am b/docs/Makefile.am
index ac9165f..3b886fc 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,4 +1,4 @@
-## Copyright (c) 2009 The libgda-uimm Development Team
+## Copyright (c) 2009, 2010 The libgda-uimm Development Team
 ##
 ## This libray is free software: you can redistribute it and/or modify it
 ## under the terms of the GNU Lesser General Public License as published by
@@ -19,6 +19,6 @@ include $(top_srcdir)/libgda-ui/libgda-uimm/filelist.am
 libgda_uimm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(LIBGDA_UIMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/libgda-ui/libgda-uimm/,$(libgda_uimm_files_h))
+doc_input = $(addprefix $(top_srcdir)/libgda-ui/libgda-uimm/,$(libgda_uimm_files_h)) $(top_srcdir)/libgda-ui/libgda-uimm.h
 
 include $(top_srcdir)/build/doc-reference.am
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index e0d0184..9b5bf07 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@
 
 #---------------------------------------------------------------------------
@@ -60,17 +60,18 @@ EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = NO
 EXTRACT_LOCAL_METHODS  = NO
 EXTRACT_ANON_NSPACES   = NO
-HIDE_UNDOC_MEMBERS     = NO
-HIDE_UNDOC_CLASSES     = NO
+HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_CLASSES     = YES
 HIDE_FRIEND_COMPOUNDS  = YES
 HIDE_IN_BODY_DOCS      = YES
 INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 HIDE_SCOPE_NAMES       = NO
-SHOW_INCLUDE_FILES     = NO
+SHOW_INCLUDE_FILES     = YES
 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
@@ -79,7 +80,7 @@ GENERATE_BUGLIST       = NO
 GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       =
 MAX_INITIALIZER_LINES  = 2
-SHOW_USED_FILES        = YES
+SHOW_USED_FILES        = NO
 SHOW_DIRECTORIES       = NO
 SHOW_FILES             = NO
 SHOW_NAMESPACES        = YES
@@ -113,6 +114,7 @@ EXCLUDE_SYMBOLS        = _* \
                          binary_function \
                          char_traits \
                          internal \
+                         nil \
                          pair \
                          unary_function
 EXAMPLE_PATH           =
@@ -172,8 +174,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
 #---------------------------------------------------------------------------
@@ -189,6 +193,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
 #---------------------------------------------------------------------------
@@ -237,6 +242,12 @@ INCLUDE_FILE_PATTERNS  = *.h
 PREDEFINED             = __cplusplus \
                          DOXYGEN_SHOULD_SKIP_THIS \
                          "G_GNUC_CONST=" \
+                         "G_GNUC_INTERNAL=" \
+                         "G_GNUC_NORETURN=" \
+                         "G_GNUC_NULL_TERMINATED=" \
+                         "G_GNUC_PURE=" \
+                         "GLIBMM_API=" \
+                         "GIOMM_API=" \
                          GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED \
                          GLIBMM_EXCEPTIONS_ENABLED \
                          GLIBMM_HAVE_WIDE_STREAM \
@@ -258,18 +269,18 @@ PERL_PATH              = @PERL@
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = NO
+CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            =
 HIDE_UNDOC_RELATIONS   = NO
 HAVE_DOT               = YES
-DOT_FONTNAME           = FreeSans
+DOT_FONTNAME           = Sans
 DOT_FONTSIZE           = 10
 DOT_FONTPATH           =
 CLASS_GRAPH            = YES
-COLLABORATION_GRAPH    = YES
-GROUP_GRAPHS           = YES
+COLLABORATION_GRAPH    = NO
+GROUP_GRAPHS           = NO
 UML_LOOK               = NO
-TEMPLATE_RELATIONS     = YES
+TEMPLATE_RELATIONS     = NO
 INCLUDE_GRAPH          = NO
 INCLUDED_BY_GRAPH      = NO
 CALL_GRAPH             = NO
@@ -285,7 +296,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/libgda-ui/libgda-uimm.h b/libgda-ui/libgda-uimm.h
index f42c17b..29f1b35 100644
--- a/libgda-ui/libgda-uimm.h
+++ b/libgda-ui/libgda-uimm.h
@@ -1,6 +1,6 @@
 /* libgda-uimm - A C++ wrapper for libgda-ui
  *
- * Copyright (c) 2009 The libgda-uimm Development Team
+ * Copyright (c) 2009, 2010 The libgda-uimm Development Team
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -20,6 +20,43 @@
 #ifndef _LIBGDA_UIMM_H
 #define _LIBGDA_UIMM_H
 
+/** @mainpage libgda-uimm Reference Manual
+ *
+ * @section description Description
+ *
+ * libgda-uimm is a C++ wrapper for libgda-ui, a library of ui widgets based
+ * on GTK+ for <a href="http://www.gnome-db.org/";>libgda</a>, the gnome
+ * database access library.  libgda-uimm wraps the libgda-ui widgets using
+ * <a href="http://www.gtkmm.org";>gtkmm</a>.  See, for example, the
+ * Gnome::GdaUI::Login widget.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the libgda-uimm header:
+ * @code
+ * #include <libgda-uimm.h>
+ * @endcode
+ * (You may include individual headers, such as @c libgda-uimm/login.h
+ * instead.)
+ *
+ * If your source file is @c program.cc, you can compile it with:
+ * @code
+ * g++ program.cc -o program  `pkg-config --cflags --libs libgda-uimm-4.0`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([LIBGDA_UIMM], [libgda-uimm-4.0])
+ * @endcode
+ * Then use the generated @c LIBGDA_UIMM_CFLAGS and @c LIBGDA_UIMM_LIBS
+ * variables in the
+ * project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(LIBGDA_UIMM_CFLAGS)
+ * program_LDADD = $(LIBGDA_UIMM_LIBS)
+ * @endcode
+ */
+
 #include <basicform.h>
 #include <cloud.h>
 #include <combo.h>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]