aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2013-01-05 16:37:11 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2013-01-05 16:37:11 +0100
commit93ee82b1fda6d395d1f70d7fb767b5dceaf4ca29 (patch)
tree21de49e996afa6db673dcff8757ed7bbbb0bf587 /Eigen
parenteac676ff6cf3f9c2d4a11e92e7211e7d763e8d6f (diff)
Big changes in Eigen documentation:
- Organize the documentation into "chapters". - Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page. - The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ). - Add a "General topics" entry for all pages that do not fit well in the previous "chapters". - The highlevel struture is managed by a new eigendoxy_layout.xml file. - remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.) - add the javascript search-engine. - add the "treeview" panel. - remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed). - add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel. - overload various javascript function generated by doxygen to: - remove the root of the treeview - remove links to section/subsection from the treeview - automatically expand the "Chapters" section - automatically expand the current section - adjust the height of the treeview to take into account the TOC - always use the default .css file, eigendoxy.css now only includes our modifications - use Doxyfile to specify our logo - remove cross references to unsupported modules (temporarily)
Diffstat (limited to 'Eigen')
-rw-r--r--Eigen/Core4
-rw-r--r--Eigen/IterativeLinearSolvers2
-rw-r--r--Eigen/OrderingMethods2
-rw-r--r--Eigen/Sparse2
-rw-r--r--Eigen/SparseCholesky2
-rw-r--r--Eigen/SparseCore2
-rw-r--r--Eigen/SparseLU2
7 files changed, 6 insertions, 10 deletions
diff --git a/Eigen/Core b/Eigen/Core
index 502a4fc55..d19fcca10 100644
--- a/Eigen/Core
+++ b/Eigen/Core
@@ -242,10 +242,6 @@ using std::ptrdiff_t;
* \endcode
*/
-/** \defgroup Support_modules Support modules [category]
- * Category of modules which add support for external libraries.
- */
-
#include "src/Core/util/Constants.h"
#include "src/Core/util/ForwardDeclarations.h"
#include "src/Core/util/Meta.h"
diff --git a/Eigen/IterativeLinearSolvers b/Eigen/IterativeLinearSolvers
index 315c2dd1e..0f4159dc1 100644
--- a/Eigen/IterativeLinearSolvers
+++ b/Eigen/IterativeLinearSolvers
@@ -6,7 +6,7 @@
#include "src/Core/util/DisableStupidWarnings.h"
-/** \ingroup Sparse_modules
+/**
* \defgroup IterativeLinearSolvers_Module IterativeLinearSolvers module
*
* This module currently provides iterative methods to solve problems of the form \c A \c x = \c b, where \c A is a squared matrix, usually very large and sparse.
diff --git a/Eigen/OrderingMethods b/Eigen/OrderingMethods
index bb43220e8..8abc128b9 100644
--- a/Eigen/OrderingMethods
+++ b/Eigen/OrderingMethods
@@ -5,7 +5,7 @@
#include "src/Core/util/DisableStupidWarnings.h"
-/** \ingroup Sparse_modules
+/**
* \defgroup OrderingMethods_Module OrderingMethods module
*
* This module is currently for internal use only.
diff --git a/Eigen/Sparse b/Eigen/Sparse
index 2d1757172..a3cee2482 100644
--- a/Eigen/Sparse
+++ b/Eigen/Sparse
@@ -1,7 +1,7 @@
#ifndef EIGEN_SPARSE_MODULE_H
#define EIGEN_SPARSE_MODULE_H
-/** \defgroup Sparse_modules Sparse modules
+/** defgroup Sparse_modules Sparse modules
*
* Meta-module including all related modules:
* - SparseCore
diff --git a/Eigen/SparseCholesky b/Eigen/SparseCholesky
index 5f82742f7..f94e2e765 100644
--- a/Eigen/SparseCholesky
+++ b/Eigen/SparseCholesky
@@ -5,7 +5,7 @@
#include "src/Core/util/DisableStupidWarnings.h"
-/** \ingroup Sparse_modules
+/**
* \defgroup SparseCholesky_Module SparseCholesky module
*
* This module currently provides two variants of the direct sparse Cholesky decomposition for selfadjoint (hermitian) matrices.
diff --git a/Eigen/SparseCore b/Eigen/SparseCore
index 1d812db2f..7a86bfa59 100644
--- a/Eigen/SparseCore
+++ b/Eigen/SparseCore
@@ -11,7 +11,7 @@
#include <cstring>
#include <algorithm>
-/** \ingroup Sparse_modules
+/**
* \defgroup SparseCore_Module SparseCore module
*
* This module provides a sparse matrix representation, and basic associatd matrix manipulations
diff --git a/Eigen/SparseLU b/Eigen/SparseLU
index b0a484947..dc532f87f 100644
--- a/Eigen/SparseLU
+++ b/Eigen/SparseLU
@@ -4,7 +4,7 @@
#include "SparseCore"
-/** \ingroup Sparse_modules
+/**
* \defgroup SparseLU_Module SparseLU module
*
*/