]> git.saurik.com Git - wxWidgets.git/commitdiff
Committing Doxygen 1.5.7+ configuration changes as Francesco has found a fix for...
authorBryan Petty <bryan@ibaku.net>
Mon, 5 Jan 2009 19:34:59 +0000 (19:34 +0000)
committerBryan Petty <bryan@ibaku.net>
Mon, 5 Jan 2009 19:34:59 +0000 (19:34 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57845 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/doxygen/Doxyfile_docset [new file with mode: 0644]
docs/doxygen/Doxyfile_inc
docs/doxygen/DoxygenLayout.xml
docs/doxygen/wxwidgets.css
docs/tech/tn0003.txt

diff --git a/docs/doxygen/Doxyfile_docset b/docs/doxygen/Doxyfile_docset
new file mode 100644 (file)
index 0000000..09b895a
--- /dev/null
@@ -0,0 +1,16 @@
+#############################################################################
+## Name:        Doxyfile_docset
+## Purpose:     Doxygen configuration file for generating Apple DocSet
+## Author:      Bryan Petty
+## RCS-ID:      $Id$
+## Licence:     wxWindows license
+#############################################################################
+
+@INCLUDE = Doxyfile_inc
+
+#---------------------------------------------------------------------------
+# Generation switches
+#---------------------------------------------------------------------------
+
+GENERATE_DOCSET         = YES
+
index fbc6af0da6f05c42a37fe2381574f61516696aaa..eeacb0666f0f76357ec0b4649f3c2b53b1a1676e 100644 (file)
@@ -29,16 +29,21 @@ SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES
 QT_AUTOBRIEF           = NO
 MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP         = YES
 INHERIT_DOCS           = YES
 SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 4
 OPTIMIZE_OUTPUT_FOR_C  = NO
 OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
 BUILTIN_STL_SUPPORT    = NO
 CPP_CLI_SUPPORT        = NO
+SIP_SUPPORT            = NO
+IDL_PROPERTY_SUPPORT   = NO
 DISTRIBUTE_GROUP_DOC   = YES
 SUBGROUPING            = YES
+TYPEDEF_HIDES_STRUCT   = NO
+SYMBOL_CACHE_SIZE      = 0
 
 # This is the most important part of the wxWidgets Doxyfile; aliases allow
 # us to keep the headers readable and "implement" wxWidgets-specific commands:
@@ -48,8 +53,8 @@ SUBGROUPING            = YES
 #---------------------------------------------------------------------------
 
 # event aliases
-ALIASES = beginEventTable{1}="\n<span class='events'>Events:</span><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
-ALIASES += beginEventTable{2}="\n<span class='events'>Events:</span><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
+ALIASES = beginEventTable{1}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
+ALIASES += beginEventTable{2}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
@@ -57,12 +62,12 @@ ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div cl
 ALIASES += endEventTable="</div>\n"
 
 # style aliases
-ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
+ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
 ALIASES += endStyleTable="</div>\n"
 
 # extra style aliases
-ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
+ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
 ALIASES += endExtraStyleTable="</div>\n"
 
 # flag aliases
@@ -80,8 +85,8 @@ ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance
 # aliases for additional wx-specific infos
 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
-ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
-ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
+ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
+ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
 
 # native implementation infos:
@@ -215,7 +220,8 @@ HIDE_SCOPE_NAMES       = NO
 SHOW_INCLUDE_FILES     = YES
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = YES
-SORT_BRIEF_DOCS        = NO     # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
+SORT_BRIEF_DOCS        = NO  # Don't set to YES, it renders our named groups out of order.
+SORT_GROUP_NAMES       = YES
 SORT_BY_SCOPE_NAME     = NO
 GENERATE_TODOLIST      = YES
 GENERATE_TESTLIST      = YES
@@ -228,8 +234,10 @@ ENABLED_SECTIONS       = WXPERL_MANUAL WXPYTHON_MANUAL
 MAX_INITIALIZER_LINES  = 30
 SHOW_USED_FILES        = NO
 SHOW_DIRECTORIES       = YES
-#SHOW_FILES             = YES # Doxygen 1.5.6+ only
+SHOW_FILES             = YES
+SHOW_NAMESPACES        = NO
 FILE_VERSION_FILTER    =
+LAYOUT_FILE            = DoxygenLayout.xml
 
 #---------------------------------------------------------------------------
 # Warning and Progress Message Options
@@ -294,17 +302,26 @@ HTML_HEADER            = htmlheader.inc
 HTML_FOOTER            = htmlfooter.inc
 HTML_STYLESHEET        =
 HTML_ALIGN_MEMBERS     = YES
-GENERATE_HTMLHELP      = NO # Only change in format output configs
 HTML_DYNAMIC_SECTIONS  = YES
+GENERATE_DOCSET        = NO # Only change in format output configs
+DOCSET_FEEDNAME        = "wxWidgets"
+DOCSET_BUNDLE_ID       = org.wxwidgets.doxygen
+GENERATE_HTMLHELP      = NO # Only change in format output configs
 CHM_FILE               = ..\wx.chm # NOTE: Windows style separator needed
 HHC_LOCATION           = hhc.exe # Don't modify, see Doxyfile_chm for info
 GENERATE_CHI           = NO
 BINARY_TOC             = NO
 TOC_EXPAND             = NO
+GENERATE_QHP           = NO
+QCH_FILE               = 
+QHP_NAMESPACE          = org.wxwidgets.doxygen
+QHP_VIRTUAL_FOLDER     = doc
+QHG_LOCATION           = 
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 1
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = NONE
 TREEVIEW_WIDTH         = 250
+FORMULA_FONTSIZE       = 10
 
 #---------------------------------------------------------------------------
 # LaTeX Output Options
@@ -400,7 +417,10 @@ CLASS_DIAGRAMS         = YES
 MSCGEN_PATH            =
 HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
-CLASS_GRAPH            = NO
+DOT_FONTNAME           = FreeSans
+DOT_FONTSIZE           = 10
+DOT_FONTPATH           = 
+CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = NO
 UML_LOOK               = NO
index b484d81b7ced5439d11a85f4b17cf16eff3f84ce..6f5eeb258c17cd1a03e97c20e7ddf991671e9af0 100644 (file)
@@ -3,7 +3,7 @@
   <navindex>
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="pages" visible="yes" title=""/>
-    <tab type="modules" visible="yes" title=""/>
+    <tab type="modules" visible="yes" title="Categories"/>
     <tab type="namespaces" visible="yes" title="">
       <tab type="namespaces" visible="yes" title=""/>
       <tab type="namespacemembers" visible="yes" title=""/>
 
   <!-- Layout definition for a class page -->
   <class>
-    <briefdescription visible="yes"/>
+    <briefdescription visible="no"/>
     <includes visible="$SHOW_INCLUDE_FILES"/>
     <inheritancegraph visible="$CLASS_GRAPH"/>
     <collaborationgraph visible="$COLLABORATION_GRAPH"/>
-    <allmemberslink visible="yes"/>
+    <detaileddescription title=""/>
     <memberdecl>
       <membergroups visible="yes"/>
       <nestedclasses visible="yes" title=""/>
@@ -61,7 +61,7 @@
       <friends title=""/>
       <related title="" subtitle=""/>
     </memberdecl>
-    <detaileddescription title=""/>
+    <allmemberslink visible="yes"/>
     <memberdef>
       <typedefs title=""/>
       <enums title=""/>
@@ -79,6 +79,7 @@
   <!-- Layout definition for a namespace page -->
   <namespace>
     <briefdescription visible="yes"/>
+    <detaileddescription title=""/>
     <memberdecl>
       <nestednamespaces visible="yes" title=""/>
       <classes visible="yes" title=""/>
@@ -88,7 +89,6 @@
       <functions title=""/>
       <variables title=""/>
     </memberdecl>
-    <detaileddescription title=""/>
     <memberdef>
       <typedefs title=""/>
       <enums title=""/>
     <includegraph visible="$INCLUDE_GRAPH"/>
     <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
     <sourcelink visible="yes"/>
+    <detaileddescription title=""/>
     <memberdecl>
       <classes visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
       <functions title=""/>
       <variables title=""/>
     </memberdecl>
-    <detaileddescription title=""/>
     <memberdef>
       <defines title=""/>
       <typedefs title=""/>
   <group>
     <briefdescription visible="yes"/>
     <groupgraph visible="$GROUP_GRAPHS"/>
+    <detaileddescription title=""/>
     <memberdecl>
       <classes visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
       <properties title=""/>
       <friends title=""/>
     </memberdecl>
-    <detaileddescription title=""/>
     <memberdef>
       <pagedocs/>
       <defines title=""/>
   <directory>
     <briefdescription visible="yes"/>
     <directorygraph visible="yes"/>
+    <detaileddescription title=""/>
     <memberdecl>
       <dirs visible="yes"/>
       <files visible="yes"/>
     </memberdecl>
-    <detaileddescription title=""/>
   </directory>
 </doxygenlayout>
index 226e96a568e26cde917e5bf62de7ab845009c5a4..9f32c5b8489b37ab9b20fa74d45893f7ad280933 100644 (file)
@@ -26,6 +26,8 @@ H1 {
 }
 H2 {
        font-size: 120%;
+    padding-top: 1em;
+    border-top: 3px solid #AAA;
 }
 H3 {
        font-size: 100%;
@@ -132,14 +134,8 @@ DL.el {
 PRE.fragment {
        border: 1px solid #CCCCCC;
        background-color: #f5f5f5;
-       margin-top: 4px;
-       margin-bottom: 4px;
-       margin-left: 2px;
-       margin-right: 8px;
-       padding-left: 6px;
-       padding-right: 6px;
-       padding-top: 4px;
-       padding-bottom: 4px;
+       margin: 4px 8px 4px 2px;
+       padding: 4px 6px;
 }
 DIV.ah {
        background-color: black;
@@ -169,27 +165,15 @@ BODY {
 TD.indexkey {
        background-color: #e8eef2;
        font-weight: bold;
-       padding-right  : 10px;
-       padding-top    : 2px;
-       padding-left   : 10px;
-       padding-bottom : 2px;
-       margin-left    : 0px;
-       margin-right   : 0px;
-       margin-top     : 2px;
-       margin-bottom  : 2px;
+       padding: 2px 10px;
+       margin: 2px 0px;
        border: 1px solid #CCCCCC;
 }
 TD.indexvalue {
        background-color: #e8eef2;
        font-style: italic;
-       padding-right  : 10px;
-       padding-top    : 2px;
-       padding-left   : 10px;
-       padding-bottom : 2px;
-       margin-left    : 0px;
-       margin-right   : 0px;
-       margin-top     : 2px;
-       margin-bottom  : 2px;
+       padding: 2px 10px;
+       margin: 2px 0px;
        border: 1px solid #CCCCCC;
 }
 TR.memlist {
@@ -215,133 +199,32 @@ SPAN.vhdlchar      { color: #000000 }
 SPAN.vhdlkeyword   { color: #700070 }
 SPAN.vhdllogic     { color: #ff0000 }
 
-.mdescLeft {
-       padding: 0px 8px 4px 8px;
-       font-size: 90%;
-       font-style: italic;
-       background-color: #FAFAFA;
-       border-top: 1px none #E0E0E0;
-       border-right: 1px none #E0E0E0;
-       border-bottom: 1px none #E0E0E0;
-       border-left: 1px none #E0E0E0;
-       margin: 0px;
-}
-.mdescRight {
-       padding: 0px 8px 4px 8px;
-       font-size: 90%;
-       font-style: italic;
-       background-color: #FAFAFA;
-       border-top: 1px none #E0E0E0;
-       border-right: 1px none #E0E0E0;
-       border-bottom: 1px none #E0E0E0;
-       border-left: 1px none #E0E0E0;
-       margin: 0px;
-}
-.memItemLeft {
-       padding: 1px 0px 0px 8px;
-       margin: 4px;
-       border-top-width: 1px;
-       border-right-width: 1px;
-       border-bottom-width: 1px;
-       border-left-width: 1px;
-       border-top-color: #E0E0E0;
-       border-right-color: #E0E0E0;
-       border-bottom-color: #E0E0E0;
-       border-left-color: #E0E0E0;
-       border-top-style: solid;
-       border-right-style: none;
-       border-bottom-style: none;
-       border-left-style: none;
+/* Doxygen Member Description Style 1.5.7 */
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
        background-color: #FAFAFA;
-       font-size: 90%;
-}
-.memItemRight {
-       padding: 1px 8px 0px 8px;
+       border: none;
        margin: 4px;
-       border-top-width: 1px;
-       border-right-width: 1px;
-       border-bottom-width: 1px;
-       border-left-width: 1px;
-       border-top-color: #E0E0E0;
-       border-right-color: #E0E0E0;
-       border-bottom-color: #E0E0E0;
-       border-left-color: #E0E0E0;
-       border-top-style: solid;
-       border-right-style: none;
-       border-bottom-style: none;
-       border-left-style: none;
-       background-color: #FAFAFA;
-       font-size: 90%;
+       padding: 1px 0 0 8px;
 }
-.memTemplItemLeft {
-       padding: 1px 0px 0px 8px;
-       margin: 4px;
-       border-top-width: 1px;
-       border-right-width: 1px;
-       border-bottom-width: 1px;
-       border-left-width: 1px;
-       border-top-color: #E0E0E0;
-       border-right-color: #E0E0E0;
-       border-bottom-color: #E0E0E0;
-       border-left-color: #E0E0E0;
-       border-top-style: none;
-       border-right-style: none;
-       border-bottom-style: none;
-       border-left-style: none;
-       background-color: #FAFAFA;
-       font-size: 90%;
+
+.mdescLeft, .mdescRight {
+       padding: 0px 8px 4px 8px;
+       color: #555;
 }
-.memTemplItemRight {
-       padding: 1px 8px 0px 8px;
-       margin: 4px;
-       border-top-width: 1px;
-       border-right-width: 1px;
-       border-bottom-width: 1px;
-       border-left-width: 1px;
-       border-top-color: #E0E0E0;
-       border-right-color: #E0E0E0;
-       border-bottom-color: #E0E0E0;
-       border-left-color: #E0E0E0;
-       border-top-style: none;
-       border-right-style: none;
-       border-bottom-style: none;
-       border-left-style: none;
-       background-color: #FAFAFA;
-       font-size: 90%;
+
+.memItemLeft, .memItemRight, .memTemplParams {
+       border-top: 1px solid #ccc;
 }
+
 .memTemplParams {
-       padding: 1px 0px 0px 8px;
-       margin: 4px;
-       border-top-width: 1px;
-       border-right-width: 1px;
-       border-bottom-width: 1px;
-       border-left-width: 1px;
-       border-top-color: #E0E0E0;
-       border-right-color: #E0E0E0;
-       border-bottom-color: #E0E0E0;
-       border-left-color: #E0E0E0;
-       border-top-style: solid;
-       border-right-style: none;
-       border-bottom-style: none;
-       border-left-style: none;
        color: #606060;
-       background-color: #FAFAFA;
-       font-size: 90%;
-}
-.search {
-       color: #003399;
-       font-weight: bold;
-}
-FORM.search {
-       margin-bottom: 0px;
-       margin-top: 0px;
-}
-INPUT.search {
-       font-size: 75%;
-       color: #000080;
-       font-weight: normal;
-       background-color: #e8eef2;
 }
+
+/*******************************************/
+
 TD.tiny {
        font-size: 75%;
 }
@@ -361,18 +244,25 @@ TH.dirtab {
        font-weight: bold;
 }
 HR {
-       height: 1px;
-       border: none;
-       border-top: 1px solid black;
+/*
+       height: 3px;
+       margin-top: 1.5em;
+       margin-bottom: 1.5em;
+*/
+       height: 0px;
+       margin: 0;
+       border: 0px;
 }
 
 /* Style for detailed member documentation */
+
 .memtemplate {
        font-size: 80%;
        color: #606060;
        font-weight: normal;
        margin-left: 3px;
 }
+
 .memnav {
        background-color: #e8eef2;
        border: 1px solid #84b0c7;
@@ -381,30 +271,45 @@ HR {
        margin-right: 15px;
        padding: 2px;
 }
+
 .memitem {
-       padding: 4px;
-       background-color: #eef3f5;
-       border-width: 1px;
-       border-style: solid;
-       border-color: #dedeee;
-       -moz-border-radius: 8px 8px 8px 8px;
+       padding: 0;
 }
+
 .memname {
        white-space: nowrap;
        font-weight: bold;
+       padding: 2px 2px;
 }
-.memdoc{
-       padding-left: 10px;
+
+.memproto, .memdoc {
+       border: 1px solid #84b0c7;      
 }
+
 .memproto {
+       padding: 0;
        background-color: #d5e1e8;
-       width: 100%;
-       border-width: 1px;
-       border-style: solid;
-       border-color: #84b0c7;
        font-weight: bold;
-       -moz-border-radius: 8px 8px 8px 8px;
+       -webkit-border-top-left-radius: 8px;
+       -webkit-border-top-right-radius: 8px;
+       -moz-border-radius-topleft: 8px;
+       -moz-border-radius-topright: 8px;
+}
+
+.memdoc {
+       padding: 5px 8px;
+       background-color: #eef3f5;
+       border-top-width: 0;
+       -webkit-border-bottom-left-radius: 8px;
+       -webkit-border-bottom-right-radius: 8px;
+       -moz-border-radius-bottomleft: 8px;
+       -moz-border-radius-bottomright: 8px;
+}
+
+.memdoc p, .memdoc dl, .memdoc ul {
+       margin: 6px 0;
 }
+
 .paramkey {
        text-align: right;
 }
@@ -413,12 +318,16 @@ HR {
 }
 .paramname {
        color: #602020;
-       font-style: italic;
        white-space: nowrap;
 }
+.paramname em {
+       font-style: normal;
+}
+
 /* End Styling for detailed member documentation */
 
 /* for the tree view */
+
 .ftvtree {
        font-family: sans-serif;
        margin:0.5em;
@@ -447,6 +356,37 @@ HR {
        vertical-align: -30%;
 }
 
+/* these are for tree view when not used as main index */
+
+.directory-alt {
+       font-size: 100%;
+       font-weight: bold;
+}
+
+.directory-alt h3 {
+       margin: 0px;
+       margin-top: 1em;
+       font-size: 11pt;
+}
+
+.directory-alt > h3 {
+       margin-top: 0;
+}
+
+.directory-alt p {
+       margin: 0px;
+       white-space: nowrap;
+}
+
+.directory-alt div {
+       display: none;
+       margin: 0px;
+}
+
+.directory-alt img {
+       vertical-align: -30%;
+}
+
 
 
 /*
@@ -454,6 +394,12 @@ HR {
   ==============================
 */
 
+H2 > A.anchor {
+       text-decoration: none;
+       background-color: none;
+       color: black;
+}
+
 IMG.logo {
        float: right;
        margin: 20px;
@@ -510,14 +456,10 @@ DIV.eventHandler SPAN {
        font-family: monospace, fixed;
 }
 
-A[HREF="modules.html"] SPAN:before {
-       content: "Categories / ";
-}
-
 /* Doxygen defaults the top navigation tabs to a small, bold font,
    so we reset it here to a larger, normal font. */
 DIV.navigation A SPAN {
-       font-size: 120%;
+       font-size: 100%;
        font-weight: normal;
 }
 
@@ -525,10 +467,6 @@ LI {
        line-height: 115%;
 }
 
-DIV.tags LI {
-       line-height: 100%;
-}
-
 CODE {
     font-size: 110%;
     color: #444444;
index e8553aed2d11f66fff501f9273e5c68dfa9d6211..7feee05b54e856871a90f38626455e729b3eaf05 100644 (file)
@@ -34,7 +34,7 @@ Running Doxygen
 ===============
 
 First, make sure you have a recent version of Doxygen installed in your system
-(you'll need Doxygen >= 1.5.4).
+(you'll need Doxygen >= 1.5.7).
 
 On Unix: