diff options
author | Gael Guennebaud <g.gael@free.fr> | 2009-02-04 09:44:44 +0000 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2009-02-04 09:44:44 +0000 |
commit | 44a527dfa50ce9c473cbf1f446b8b6f406d4bc91 (patch) | |
tree | a0f045d2a4c22a38e08e1b1d1ce0e17e630898c7 /Mainpage.dox | |
parent | b0dd22cc7271523ba83d2bc8a85504b8445587b5 (diff) |
* classify and sort the doxygen "related pages"
by tweaking the filename and adding 2 categories:
Troubleshooting and Advanced
* use the EXCLUDE_SYMBOLS to clean the class list
(insteaded of a homemade bash script)
* remove the broken "exemple list"
* re-structure the unsupported directory as mentionned in the ML and
integrate the doc as follow:
- snippets of the unsupported directory are directly imported from the
main snippets/CMakefile.txt (no need to duplicate code)
- add a top level "Unsupported modules" group
- unsupported modules have to defined their own sub group and nest it
using \ingroup Unsupported_modules
- then a pair of //@{ //@} will put everything in the submodule
- this is just a proposal !
Diffstat (limited to 'Mainpage.dox')
-rw-r--r-- | Mainpage.dox | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Mainpage.dox b/Mainpage.dox index 468045dce..b5b7f30fa 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -54,7 +54,7 @@ // DOXYGEN_SET_WARN_IF_UNDOCUMENTED = NO // DOXYGEN_SET_WARN_NO_PARAMDOC = NO -// DOXYGEN_SET_INPUT = @topdir@/eigen2/Eigen @topdir@/eigen2/doc @topdir@/eigen2/build/doc +// DOXYGEN_SET_INPUT = @topdir@/eigen2/Eigen @topdir@/eigen2/doc @topdir@/eigen2/build/doc @topdir@/eigen2/unsupported/Eigen // DOXYGEN_SET_EXCLUDE = *.sh *.in // DOXYGEN_SET_EXAMPLE_PATH = @topdir@/eigen2/doc/snippets/ @topdir@/eigen2/doc/examples/ @topdir@/eigen2/build/doc/examples/ @topdir@/eigen2/build/doc/snippets/ @@ -63,6 +63,8 @@ // DOXYGEN_SET_RECURSIVE = NO // DOXYGEN_SET_FILTER_SOURCE_FILES = YES +// DOXYGEN_EXCLUDE_SYMBOLS = MatrixBase<* MapBase<* RotationBase<* Matrix<* + // DOXYGEN_SET_SOURCE_BROWSER = NO // DOXYGEN_SET_INLINE_SOURCES = NO // DOXYGEN_SET_STRIP_CODE_COMMENTS = YES |