Skip to content

Commit

Permalink
[docs] Touch up the Doxygen config. Make the docs full width again an…
Browse files Browse the repository at this point in the history
…d add a tree view navigator on the left while removing the top bar.
  • Loading branch information
jverkoey committed Jul 2, 2011
1 parent 5abe4c9 commit fef1cc0
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
28 changes: 14 additions & 14 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ SHORT_NAMES = NO
# 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
Expand Down Expand Up @@ -456,7 +456,7 @@ SORT_MEMBERS_CTORS_1ST = NO
# hierarchy of group names into alphabetical order. If set to NO (the default)
# the group names will appear in their defined order.

SORT_GROUP_NAMES = NO
SORT_GROUP_NAMES = 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
Expand All @@ -481,25 +481,25 @@ STRICT_PROTO_MATCHING = NO
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.

GENERATE_TODOLIST = YES
GENERATE_TODOLIST = NO

# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.

GENERATE_TESTLIST = YES
GENERATE_TESTLIST = NO

# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.

GENERATE_BUGLIST = YES
GENERATE_BUGLIST = NO

# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
# disable (NO) the deprecated list. This list is created by putting
# \deprecated commands in the documentation.

GENERATE_DEPRECATEDLIST= YES
GENERATE_DEPRECATEDLIST= NO

# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
Expand All @@ -520,7 +520,7 @@ MAX_INITIALIZER_LINES = 30
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.

SHOW_USED_FILES = YES
SHOW_USED_FILES = NO

# If the sources in your project are distributed over multiple directories
# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
Expand Down Expand Up @@ -921,13 +921,13 @@ HTML_COLORSTYLE_SAT = 100
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.

HTML_COLORSTYLE_GAMMA = 80
HTML_COLORSTYLE_GAMMA = 130

# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.

HTML_TIMESTAMP = YES
HTML_TIMESTAMP = NO

# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
Expand Down Expand Up @@ -961,20 +961,20 @@ GENERATE_DOCSET = YES
# documentation sets from a single provider (such as a company or product suite)
# can be grouped.

DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_FEEDNAME = "Nimbus Documentation"

# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# should uniquely identify the documentation set bundle. This should be a
# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# will append .docset to the name.

DOCSET_BUNDLE_ID = org.doxygen.nimbus
DOCSET_BUNDLE_ID = org.jeffverkoeyen.nimbus

# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
# the documentation publisher. This should be a reverse domain-name style
# string, e.g. com.mycompany.MyDocSet.documentation.

DOCSET_PUBLISHER_ID = org.doxygen.Nimbus
DOCSET_PUBLISHER_ID = org.jeffverkoeyen.nimbus

# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.

Expand Down Expand Up @@ -1098,7 +1098,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.

DISABLE_INDEX = NO
DISABLE_INDEX = YES

# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
Expand All @@ -1115,7 +1115,7 @@ ENUM_VALUES_PER_LINE = 4
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
# Windows users are probably better off using the HTML help feature.

GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES

# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
# and Class Hierarchy pages using a tree view instead of an ordered list.
Expand Down
6 changes: 3 additions & 3 deletions docs/footer.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
</div><!-- .fixedwidth -->

<!--BEGIN GENERATE_TREEVIEW-->
<li class="footer">Generated on $datetime for $projectname by
<span class="footer">Generated for $projectname by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </span>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
Generated on $datetime for $projectname by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="$relpath$doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address>
Generated for $projectname by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="$relpath$doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address>
<!--END !GENERATE_TREEVIEW-->
</div> <!-- page -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>$title</title>
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
<link href="$relpath$stylesheet.css" rel="stylesheet" type="text/css" />
$treeview
<link href="$relpath$stylesheet.css" rel="stylesheet" type="text/css" />
$search
$mathjax
</head>
<body>
<div id="page">
<div class="fixedwidth">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<a href="http://github.com/jverkoey/nimbus"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://d3nwyuy0nl342s.cloudfront.net/img/e6bef7a091f5f3138b8cd40bc3e114258dd68ddf/687474703a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f7265645f6161303030302e706e67" alt="Fork Nimbus on GitHub"></a>
<!--BEGIN TITLEAREA-->
Expand Down

0 comments on commit fef1cc0

Please sign in to comment.