diff options
author | Michael Cahill <michael.cahill@wiredtiger.com> | 2012-02-01 17:26:45 +1100 |
---|---|---|
committer | Michael Cahill <michael.cahill@wiredtiger.com> | 2012-02-01 17:26:45 +1100 |
commit | 858f348ede21f1be5ab607434b6d2c7fe8f9ebe5 (patch) | |
tree | 987d1ea0b8d530a026c40384551e9ed99d64f3f0 | |
parent | 26d8f2ca8fa0451c103d031a8c31c26cff1494f4 (diff) | |
download | mongo-858f348ede21f1be5ab607434b6d2c7fe8f9ebe5.tar.gz |
Documentation tweaks for the public copy.
-rw-r--r-- | docs/Doxyfile | 2 | ||||
-rw-r--r-- | docs/src/introduction.dox | 3 | ||||
-rw-r--r-- | docs/src/using.dox | 1 | ||||
-rw-r--r-- | docs/style/DoxygenLayout.xml | 189 | ||||
-rw-r--r-- | docs/style/footer.html | 4 |
5 files changed, 196 insertions, 3 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 94f4bfbcc65..0f1dfda9ed5 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -573,7 +573,7 @@ FILE_VERSION_FILTER = # You can optionally specify a file name after the option, if omitted # DoxygenLayout.xml will be used as the name of the layout file. -LAYOUT_FILE = +LAYOUT_FILE = style/DoxygenLayout.xml #--------------------------------------------------------------------------- # configuration options related to warning and progress messages diff --git a/docs/src/introduction.dox b/docs/src/introduction.dox index c0e07e7ad60..ae8363856b0 100644 --- a/docs/src/introduction.dox +++ b/docs/src/introduction.dox @@ -15,6 +15,9 @@ of a row are stored together, WiredTiger supports column-oriented storage, where one or more columns can be stored individually, allowing more efficient access and storage. +To download the WiredTiger source code, visit our +<a href="https://github.com/wiredtiger/wiredtiger"><b>Project page</b></a>. + For more information about using WiredTiger, see: - @subpage install\n diff --git a/docs/src/using.dox b/docs/src/using.dox index 1faf7146961..1b0307bbfe1 100644 --- a/docs/src/using.dox +++ b/docs/src/using.dox @@ -15,6 +15,7 @@ Additional Notes: - @subpage home - @subpage security - @subpage file_formats +- @subpage compression - @subpage name_space - @subpage signals - @subpage tuning diff --git a/docs/style/DoxygenLayout.xml b/docs/style/DoxygenLayout.xml new file mode 100644 index 00000000000..aba0f30750b --- /dev/null +++ b/docs/style/DoxygenLayout.xml @@ -0,0 +1,189 @@ +<doxygenlayout version="1.0"> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title=""/> + <tab type="pages" visible="yes" title="" intro=""/> + <tab type="modules" visible="yes" title="" intro=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespacelist" visible="yes" title="" intro=""/> + <tab type="namespacemembers" visible="yes" title="" intro=""/> + </tab> + <tab type="classes" visible="no" title=""> + <tab type="classlist" visible="yes" title="" intro=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title="" intro=""/> + <tab type="classmembers" visible="yes" title="" intro=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="filelist" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> + </tab> + <tab type="dirs" visible="yes" title="" intro=""/> + <tab type="examples" visible="yes" title="" intro=""/> + <tab type="user" url="https://github.com/wiredtiger/wiredtiger" visible="yes" title="Download"/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/docs/style/footer.html b/docs/style/footer.html index 4f23174c97c..19c1f1a0d9c 100644 --- a/docs/style/footer.html +++ b/docs/style/footer.html @@ -1,11 +1,11 @@ <!--BEGIN GENERATE_TREEVIEW--> - <li class="footer">Copyright (c) 2008-2011 WiredTiger. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li> + <li class="footer">Copyright (c) 2008-2012 WiredTiger. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</li> </ul> </div> <!--END GENERATE_TREEVIEW--> <!--BEGIN !GENERATE_TREEVIEW--> <hr class="footer"/><address class="footer"><small> -Copyright (c) 2008-2011 WiredTiger. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</small></address> +Copyright (c) 2008-2012 WiredTiger. All rights reserved. Contact <a href="mailto:info@wiredtiger.com">info@wiredtiger.com</a> for more information.</small></address> <!--END !GENERATE_TREEVIEW--> </body> </html> |