aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-08-28 23:25:27 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-08-28 23:25:27 +0000
commit409e82be06bd6e0e3772f57cc3cc19c35743d09c (patch)
tree921ce78ed8534d33c1e1a74b725839c83615bc05 /doc
parent7ea821d18e6b1294acf170b805c3c132c47f2f77 (diff)
doc and use sed to clean the class hierarchy instead of
preprocessor directives.
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt1
-rw-r--r--doc/QuickStartGuide.dox7
-rwxr-xr-xdoc/cleanhierarchy.sh4
3 files changed, 8 insertions, 4 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index e2a31978c..c8693af84 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -38,6 +38,7 @@ ADD_CUSTOM_TARGET(
${CMAKE_CURRENT_BINARY_DIR}/html/
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/buildexamplelist.sh ${CMAKE_SOURCE_DIR} > ${CMAKE_CURRENT_BINARY_DIR}/ExampleList.dox
COMMAND doxygen
+ COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/cleanhierarchy.sh ${CMAKE_CURRENT_BINARY_DIR}/html/hierarchy.html
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox
index a2fe4f23d..d8a58b208 100644
--- a/doc/QuickStartGuide.dox
+++ b/doc/QuickStartGuide.dox
@@ -188,7 +188,7 @@ MatrixXi mat2x2 = Map<MatrixXi>(data,2,2);
\subsection TutorialCommaInit Comma initializer
-Eigen also offer a \link MatrixBase::operator<<(const Scalar &) comma initializer syntax \endlink which allows you to set all the coefficients of a matrix to specific values:
+Eigen also offer a \ref MatrixBaseCommaInitRef "comma initializer syntax" which allows you to set all the coefficients of a matrix to specific values:
<table class="tutorial_code"><tr><td>
\include Tutorial_commainit_01.cpp
</td>
@@ -295,8 +295,7 @@ etc.
<td><table class="tutorial_code">
<tr><td>
\b Trigo: \n
-\link Cwise::sin sin \endlink, \link Cwise::cos cos \endlink,
-\link Cwise::tan tan \endlink</td><td>\code
+\link Cwise::sin sin \endlink, \link Cwise::cos cos \endlink</td><td>\code
mat3 = mat1.cwise().sin();
etc.
\endcode
@@ -538,7 +537,7 @@ more compact, fast and stable. AngleAxis are only useful to create other rotatio
\subsection TutorialGeoCommonRotationAPI Common API across rotation types
-To some extent, Eigen's \ref Geometry_Module "geometry module" allows you to write
+To some extent, Eigen's \ref GeometryModule "geometry module" allows you to write
generic algorithms working on both 2D and 3D rotations of any of the five above types.
The following operation are supported:
<table class="tutorial_code">
diff --git a/doc/cleanhierarchy.sh b/doc/cleanhierarchy.sh
new file mode 100755
index 000000000..892cf393c
--- /dev/null
+++ b/doc/cleanhierarchy.sh
@@ -0,0 +1,4 @@
+#!/bin/sh
+
+sed -i 's/^.li.*MatrixBase\&lt.*gt.*a.$/ /g' $1
+sed -i 's/^.li.*MapBase\&lt.*gt.*a.$/ /g' $1