aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Doxyfile.in
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-11-22 19:51:05 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-11-22 19:51:05 +0000
commit582c1f92c81b264f3eb52d745bf8e607bc9a6ee6 (patch)
tree26be2455f13841a6779fc24127edf63210334a4c /doc/Doxyfile.in
parenta040b7f15daa915b997dd4776ce84809ff38fbe6 (diff)
doc: add a "non stable" warning for parts which are not part
of the stable API yet and a couple of other minor doc updates...
Diffstat (limited to 'doc/Doxyfile.in')
-rw-r--r--doc/Doxyfile.in3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index f5e7a7100..7e3966c65 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -207,7 +207,8 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"regression_module=This is defined in the %Regression module. \code #include <Eigen/Regression> \endcode" \
"addexample=\anchor" \
"label=\bug" \
- "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'><span style='color:red'>*</span></a>"
+ "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'><span style='color:red'>*</span></a>" \
+ "nonstableyet=\warning This class/function is not considered to be part of the stable public API yet. Some (minor) changes might happen in future releases."
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.