diff options
author | Gael Guennebaud <g.gael@free.fr> | 2008-11-22 19:51:05 +0000 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2008-11-22 19:51:05 +0000 |
commit | 582c1f92c81b264f3eb52d745bf8e607bc9a6ee6 (patch) | |
tree | 26be2455f13841a6779fc24127edf63210334a4c /doc | |
parent | a040b7f15daa915b997dd4776ce84809ff38fbe6 (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')
-rw-r--r-- | doc/Doxyfile.in | 3 | ||||
-rw-r--r-- | doc/TutorialGeometry.dox | 6 |
2 files changed, 5 insertions, 4 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. diff --git a/doc/TutorialGeometry.dox b/doc/TutorialGeometry.dox index 8742341f5..5a1a3e06e 100644 --- a/doc/TutorialGeometry.dox +++ b/doc/TutorialGeometry.dox @@ -67,7 +67,7 @@ might still be interesting to write generic and efficient algorithms taking as i kind of transformations. Any of the above transformation types can be converted to any other types of the same nature, -or to a more generic type. Here are come additional examples: +or to a more generic type. Here are some additional examples: <table class="tutorial_code"> <tr><td>\code Rotation2Df r = Matrix2f(..); // assumes a pure rotation matrix @@ -176,7 +176,7 @@ t.pretranslate(Vector_(tx,ty,..)); t *= Translation_(tx,ty,..); t = Translation_(tx,ty,..) * t; \endcode</td></tr> -<tr><td>\b Rotation \n <em class="note">In 2D, any_rotation can also \n be an angle in radian</em></td><td>\code +<tr><td>\b Rotation \n <em class="note">In 2D and for the procedural API, any_rotation can also \n be an angle in radian</em></td><td>\code t.rotate(any_rotation); t.prerotate(any_rotation); \endcode</td><td>\code @@ -216,7 +216,7 @@ t = Translation_(..) * t * RotationType(..) * Translation_(..) * Scaling_(..); <table class="tutorial_code"> <tr><td style="max-width:30em;"> Euler angles might be convenient to create rotation objects. -On the other hand, since there exist 24 differents convensions,they are pretty confusing to use. This example shows how +On the other hand, since there exist 24 differents convension,they are pretty confusing to use. This example shows how to create a rotation matrix according to the 2-1-2 convention.</td><td>\code Matrix3f m; m = AngleAxisf(angle1, Vector3f::UnitZ()) |