GNOME.org
 

[glibmm] Predefine G_OS_UNIX or G_OS_WIN32 in Doxygen's configuration file.

commit 298776469eaaa899d6d1fce14342838dbe324c62
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Wed Jan 30 10:46:29 2013 +0100

    Predefine G_OS_UNIX or G_OS_WIN32 in Doxygen's configuration file.
    
    * docs/reference/Doxyfile.in: Predefine either G_OS_UNIX or G_OS_WIN32,
    depending on HOST_WINDOWS_NATIVE. Update to Doxygen 1.8.3 status.
    * glib/src/iochannel.hg: Remove the DOXYGEN_SHOULD_SKIP_THIS that was added
    just to get Windows-specific methods included in the documentation.

 ChangeLog                  |    9 ++++++
 docs/reference/Doxyfile.in |   60 +++++++++++++++++++++++++++++++++++++++----
 glib/src/iochannel.hg      |    5 +--
 3 files changed, 65 insertions(+), 9 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 93d325e..d22d716 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2013-01-30  Kjell Ahlstedt  <kjell ahlstedt bredband net>
 
+	Predefine G_OS_UNIX or G_OS_WIN32 in Doxygen's configuration file.
+
+	* docs/reference/Doxyfile.in: Predefine either G_OS_UNIX or G_OS_WIN32,
+	depending on HOST_WINDOWS_NATIVE. Update to Doxygen 1.8.3 status.
+	* glib/src/iochannel.hg: Remove the DOXYGEN_SHOULD_SKIP_THIS that was added
+	just to get Windows-specific methods included in the documentation.
+
+2013-01-30  Kjell Ahlstedt  <kjell ahlstedt bredband net>
+
 	DBus::[Connection|Proxy]: Change ifdef G_OS_LINUX to ifdef G_OS_UNIX.
 
 	* gio/src/dbusconnection.[ccg|hg]:
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index 4641bb7..2f5242b 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -1,12 +1,20 @@
-# Doxyfile 1.6.1
+# Doxyfile 1.8.3
 # @configure_input@
 
+# When Doxyfile.in is updated with 'doxygen -s -u Doxyfile.in' some lines
+# will be distorted or removed, and must be manually restored.
+# - These comment lines, including the configure_input line.
+# - The lines with HOST_WINDOWS_NATIVE_[FALSE|TRUE].
+# (True of Doxygen 1.8.3. Don't know how future releases will behave.)
+
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = @PACKAGE_NAME@
 PROJECT_NUMBER         = @PACKAGE_VERSION@
+PROJECT_BRIEF          =
+PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = reference
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
@@ -35,25 +43,33 @@ MULTILINE_CPP_IS_BRIEF = NO
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 8
-ALIASES                = "newin{2}=\xrefitem since_\1_\2 \"Since @PACKAGE_NAME@ \1.\2\" \"New API in @PACKAGE_NAME@ \1.\2\""
+ALIASES                = "newin{2}=\xrefitem since_\1_\2 \"Since @PACKAGE_NAME@ \1.\2\" \"New API in @PACKAGE_NAME@ \1.\2\"" \
+                         "newin{3}=\xrefitem since_\1_\2_\3 \"Since @PACKAGE_NAME@ \1.\2.\3\" \"New API in @PACKAGE_NAME@ \1.\2.\3\""
+TCL_SUBST              =
 OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
 EXTENSION_MAPPING      =
+MARKDOWN_SUPPORT       = YES
+AUTOLINK_SUPPORT       = YES
 BUILTIN_STL_SUPPORT    = NO
 CPP_CLI_SUPPORT        = NO
 SIP_SUPPORT            = NO
 IDL_PROPERTY_SUPPORT   = YES
 DISTRIBUTE_GROUP_DOC   = NO
 SUBGROUPING            = YES
+INLINE_GROUPED_CLASSES = NO
+INLINE_SIMPLE_STRUCTS  = NO
 TYPEDEF_HIDES_STRUCT   = NO
 SYMBOL_CACHE_SIZE      = 0
+LOOKUP_CACHE_SIZE      = 0
 #---------------------------------------------------------------------------
 # Build related configuration options
 #---------------------------------------------------------------------------
 EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = NO
+EXTRACT_PACKAGE        = NO
 EXTRACT_STATIC         = NO
 EXTRACT_LOCAL_CLASSES  = NO
 EXTRACT_LOCAL_METHODS  = NO
@@ -66,12 +82,14 @@ INTERNAL_DOCS          = NO
 CASE_SENSE_NAMES       = YES
 HIDE_SCOPE_NAMES       = NO
 SHOW_INCLUDE_FILES     = YES
+FORCE_LOCAL_INCLUDES   = 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
+STRICT_PROTO_MATCHING  = NO
 GENERATE_TODOLIST      = NO
 GENERATE_TESTLIST      = NO
 GENERATE_BUGLIST       = NO
@@ -79,11 +97,11 @@ GENERATE_DEPRECATEDLIST= YES
 ENABLED_SECTIONS       =
 MAX_INITIALIZER_LINES  = 2
 SHOW_USED_FILES        = NO
-SHOW_DIRECTORIES       = NO
 SHOW_FILES             = NO
 SHOW_NAMESPACES        = YES
 FILE_VERSION_FILTER    =
 LAYOUT_FILE            =
+CITE_BIB_FILES         =
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
 #---------------------------------------------------------------------------
@@ -123,6 +141,8 @@ IMAGE_PATH             =
 INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
+FILTER_SOURCE_PATTERNS =
+USE_MDFILE_AS_MAINPAGE =
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -149,11 +169,19 @@ HTML_FILE_EXTENSION    = .html
 HTML_HEADER            =
 HTML_FOOTER            =
 HTML_STYLESHEET        = "@abs_top_srcdir@/docs/doxygen.css"
-HTML_ALIGN_MEMBERS     = YES
+HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_FILES       =
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
+HTML_TIMESTAMP         = YES
 HTML_DYNAMIC_SECTIONS  = NO
+HTML_INDEX_NUM_ENTRIES = 100
 GENERATE_DOCSET        = NO
 DOCSET_FEEDNAME        = "Doxygen generated docs"
 DOCSET_BUNDLE_ID       = org.doxygen.Project
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+DOCSET_PUBLISHER_NAME  = Publisher
 GENERATE_HTMLHELP      = NO
 CHM_FILE               =
 HHC_LOCATION           =
@@ -169,13 +197,25 @@ QHP_CUST_FILTER_NAME   =
 QHP_CUST_FILTER_ATTRS  =
 QHP_SECT_FILTER_ATTRS  =
 QHG_LOCATION           =
+GENERATE_ECLIPSEHELP   = NO
+ECLIPSE_DOC_ID         = org.doxygen.Project
 DISABLE_INDEX          = NO
+GENERATE_TREEVIEW      = NO
 ENUM_VALUES_PER_LINE   = 1
-GENERATE_TREEVIEW      = NONE
-USE_INLINE_TREES       = NO
 TREEVIEW_WIDTH         = 250
+EXT_LINKS_IN_WINDOW    = NO
 FORMULA_FONTSIZE       = 10
+FORMULA_TRANSPARENT    = YES
+USE_MATHJAX            = NO
+MATHJAX_FORMAT         = HTML-CSS
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+MATHJAX_EXTENSIONS     =
 SEARCHENGINE           = NO
+SERVER_BASED_SEARCH    = NO
+EXTERNAL_SEARCH        = NO
+SEARCHENGINE_URL       =
+SEARCHDATA_FILE        = searchdata.xml
+EXTRA_SEARCH_MAPPINGS  =
 #---------------------------------------------------------------------------
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
@@ -187,11 +227,13 @@ COMPACT_LATEX          = NO
 PAPER_TYPE             = a4wide
 EXTRA_PACKAGES         =
 LATEX_HEADER           =
+LATEX_FOOTER           =
 PDF_HYPERLINKS         = YES
 USE_PDFLATEX           = YES
 LATEX_BATCHMODE        = NO
 LATEX_HIDE_INDICES     = NO
 LATEX_SOURCE_CODE      = NO
+LATEX_BIB_STYLE        = plain
 #---------------------------------------------------------------------------
 # configuration options related to the RTF output
 #---------------------------------------------------------------------------
@@ -253,6 +295,8 @@ PREDEFINED             = __cplusplus \
                          GLIBMM_HAVE_WIDE_STREAM \
                          GLIBMM_PROPERTIES_ENABLED \
                          GLIBMM_VFUNCS_ENABLED
+ HOST_WINDOWS_NATIVE_FALSE@PREDEFINED += G_OS_UNIX
+ HOST_WINDOWS_NATIVE_TRUE@PREDEFINED += G_OS_WIN32
 EXPAND_AS_DEFINED      = GLIBMM_MAJOR_VERSION \
                          GLIBMM_MINOR_VERSION \
                          GLIBMM_MICRO_VERSION \
@@ -275,6 +319,7 @@ CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            =
 HIDE_UNDOC_RELATIONS   = NO
 HAVE_DOT               = YES
+DOT_NUM_THREADS        = 0
 DOT_FONTNAME           = Sans
 DOT_FONTSIZE           = 10
 DOT_FONTPATH           =
@@ -282,6 +327,7 @@ CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = NO
 UML_LOOK               = NO
+UML_LIMIT_NUM_FIELDS   = 10
 TEMPLATE_RELATIONS     = NO
 INCLUDE_GRAPH          = NO
 INCLUDED_BY_GRAPH      = NO
@@ -290,8 +336,10 @@ CALLER_GRAPH           = NO
 GRAPHICAL_HIERARCHY    = YES
 DIRECTORY_GRAPH        = NO
 DOT_IMAGE_FORMAT       = png
+INTERACTIVE_SVG        = NO
 DOT_PATH               =
 DOTFILE_DIRS           =
+MSCFILE_DIRS           =
 DOT_GRAPH_MAX_NODES    = 50
 MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = NO
diff --git a/glib/src/iochannel.hg b/glib/src/iochannel.hg
index 2c89419..bc0f404 100644
--- a/glib/src/iochannel.hg
+++ b/glib/src/iochannel.hg
@@ -140,8 +140,7 @@ public:
   static Glib::RefPtr<IOChannel> create_from_fd(int fd);
   _IGNORE(g_io_channel_unix_new)
 
-/* defined(DOXYGEN_SHOULD_SKIP_THIS) actually does the opposite of what it looks like... */
-#if defined(G_OS_WIN32) || defined(DOXYGEN_SHOULD_SKIP_THIS)
+#ifdef G_OS_WIN32
 
   /** Create an I/O channel for C runtime (emulated Unix-like) file descriptors.
    * After calling add_watch() on a I/O channel returned by this function, you
@@ -162,7 +161,7 @@ public:
   static Glib::RefPtr<IOChannel> create_from_win32_socket(int socket);
   _IGNORE(g_io_channel_win32_new_socket)
 
-#endif /* defined(G_OS_WIN32) || defined(DOXYGEN_SHOULD_SKIP_THIS) */
+#endif /* G_OS_WIN32 */
 
   /** Read a single UCS-4 character.
    * @retval thechar The Unicode character.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]