Skip to content
Snippets Groups Projects
Commit 73ec68d5 authored by Oliver Bock's avatar Oliver Bock
Browse files

Extended documentation

* Added a "header" which holds the index page's content (to be continued...)
* Fixed excludes
* Disabled the doxygen tree view (ugly and no advantage)
parent e2c1d8b5
No related branches found
No related tags found
No related merge requests found
...@@ -249,7 +249,7 @@ EXTRACT_PRIVATE = YES ...@@ -249,7 +249,7 @@ EXTRACT_PRIVATE = YES
# If the EXTRACT_STATIC tag is set to YES all static members of a file # If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation. # will be included in the documentation.
EXTRACT_STATIC = NO EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation. # defined locally in source files will be included in the documentation.
...@@ -477,7 +477,7 @@ WARN_LOGFILE = ...@@ -477,7 +477,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = src/framework src/orc src/starsphere INPUT = src/framework src/orc src/starsphere src/doxygen_index.h
# This tag can be used to specify the character encoding of the source files that # This tag can be used to specify the character encoding of the source files that
# doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default
...@@ -505,7 +505,7 @@ RECURSIVE = YES ...@@ -505,7 +505,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a # excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag. # subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = *.svn doxygen EXCLUDE = *.svn *CVS
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix filesystem feature) are excluded # directories that are symbolic links (a Unix filesystem feature) are excluded
...@@ -771,7 +771,7 @@ ENUM_VALUES_PER_LINE = 4 ...@@ -771,7 +771,7 @@ ENUM_VALUES_PER_LINE = 4
# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
# probably better off using the HTML help feature. # probably better off using the HTML help feature.
GENERATE_TREEVIEW = YES GENERATE_TREEVIEW = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree # used to set the initial width (in pixels) of the frame in which the tree
......
/*! \mainpage Einstein@Home Graphics Application
*
* \section cha_intro Introduction
*
* This is the introduction.
*
* \section cha_app The Graphics Application
*
* \subsection sec_app_overview Overview
* \subsection sec_app_usage Usage
* \subsection sec_app_install Installation
*
* \section cha_frame The Framework
* \subsection sec_frame_overview Overview
* \subsection sec_frame_usage Usage
*
* \section cha_orc The Open Resource Compiler
* \subsection sec_orc_overview Overview
* \subsection sec_orc_usage Usage
*/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment