Commit Graph

53 Commits

Author SHA1 Message Date
Laurent Saboret 786f9d5768 Automatic documentation improvements by generate_reference_manual 1.3:
- Reduced left margin of free functions description.
- Fixed bug: fixed vertical alignment in methods/functions description.
- Fixed bug: does not remove anymore EOLs in methods/functions description.
- Fixed bug #7515: removed "[protected]", "[static]" and "[virtual]" comments.
2009-06-11 08:38:15 +00:00
Laurent Saboret d2d7321ef2 Replaced temporay hack in generate_reference_manual r49560:
Use [A-Z][a-z]+[A-Z]\w* regex to match concepts names and wrap them by \ccc{}.
2009-05-27 13:10:10 +00:00
Laurent Saboret 78dcb5c219 * Workaround bug in cgal_manual: call \ccTagFullDeclarations at the beginning of \ccOperations.
This forces cgal_manual to expand const keyword are avoids 2 problems:
- bad keywords in HTML
- const and non-const methods seem identical.

* Also fixed a bug in copy_doxygen_latex_doc r49560:
cgal_manual compilation error on mst_orient_normals.tex.
2009-05-25 14:31:23 +00:00
Laurent Saboret e53b592e19 TEMPORARY: a few concept names are hard-coded in copy_doxygen_latex_doc until I find a better implementation:
PolylineSimplificationCostFunction
PolylineSimplificationStopPredicate
PolylineSimplificationVertex
ImplicitFunction
InputIterator
OutputIterator
ForwardIterator
2009-05-25 12:52:45 +00:00
Laurent Saboret 4172e5e4e7 Automatic documentation 2009-04-20 17:00:15 +00:00
Laurent Saboret cb4a60cc50 Automatic documentation by generate_reference_manual version 1.2 2009-04-16 14:45:42 +00:00
Laurent Saboret 8ed2c75021 Automatic documentation by generate_reference_manual 1.1.2 2009-04-09 12:49:30 +00:00
Laurent Saboret 689118b8d1 Fixed misspelling: "an halfedge" -> "a halfedge" 2009-03-18 08:59:29 +00:00
Laurent Saboret d0f63a9ee1 Automatic documentation by generate_reference_manual 1.1:
* Bug fixes:
- Document properly the template parameters of functions. No separate Parameters section.

* Improved formatting of functions and methods:
- Shorter latex code and shorter printed documentation
- Fixed indentation
- Parameter names are in italic instead of bold

* Words surrounded by stars are formatted in bold.
2009-02-26 11:05:12 +00:00
Laurent Saboret 6595450524 Optimization of speed and memory footprint 2008-10-13 09:32:09 +00:00
Laurent Saboret f7c1e0df6d Fixed declaration of templated methods 2008-09-30 14:32:19 +00:00
Laurent Saboret 242349559d Updated reference manual 2008-08-20 15:16:34 +00:00
Laurent Saboret 42f40a7fc2 Changed the way parameterization errors are reported. Now:
- there is a clear distinction between internal errors (aka bugs) and not supported input files (typically models which are not topological discs),
- internal errors trigger a test suite failure.

The main consequence is that OpenNL errors trigger now a test suite failure.
2008-08-20 14:47:53 +00:00
Laurent Saboret fa30accac8 Surface_mesh_parameterization pre-conditions and post-conditions are now always checked,
in order to catch input meshes that do not respect them and avoid crashes in Release mode: 
- For fixed border parameterizations:
 Preconditions:
     check that the border is mapped onto a convex polygon.
     check that the input mesh is triangular (expensive check).
     check that the input mesh is a surface with one connected component (expensive check).
 Postconditions:
     check one-to-one mapping.
- For free border parameterizations:
 Preconditions:
     check that the input mesh is triangular (expensive check).
     check that the input mesh is a surface with one connected component (expensive check).
 Postconditions:
     check one-to-one mapping.
2008-08-19 15:50:40 +00:00
Laurent Saboret 11366f0a6c Automatic documentation by generate_reference_documentation 1.0.2 2008-04-04 16:40:07 +00:00
Laurent Saboret 500fc2f95c Update to generate_reference_manual 1.0.1 2008-03-07 13:43:59 +00:00
Laurent Saboret e2f3e93490 Update to generate_reference_manual 1.0 2008-02-22 13:03:40 +00:00
Laurent Saboret d64885d524 Improved \ccHasModels parsing 2008-02-20 14:36:52 +00:00
Laurent Saboret 70a58205c3 Fixed \ccVariables support 2008-02-20 11:46:17 +00:00
Laurent Saboret 0c9edbfd24 Words surrounded by simple quotes are emphasized using \ccc 2008-02-18 18:38:09 +00:00
Laurent Saboret a36cb5d3fd Update to doxygen 1.5 and generate_reference_manual 0.8: methods implemented out of a class declaration should not repeat the doxygen documentation 2008-01-25 16:32:47 +00:00
Laurent Saboret a661ae2211 Regenerated Reference Manual with generate_reference_manual 0.7.5. 2007-09-07 15:27:39 +00:00
Laurent Saboret 7c2497c5d0 More spell checking 2007-04-23 12:11:29 +00:00
Sylvain Pion ae90c1131c Spell check. 2007-04-17 15:52:01 +00:00
Laurent Saboret b1e1b6576b Automatic update of the reference manual 2007-02-07 08:47:21 +00:00
Laurent Saboret 1684a3d07f Fixed clash with ERROR_NOT_ENOUGH_MEMORY #define in Windows header 2006-08-31 09:35:52 +00:00
Laurent Saboret 94cf886ffe automatically generated 2006-08-21 15:41:47 +00:00
Laurent Saboret 5199806fe1 automatically generated 2006-08-21 15:41:01 +00:00
Andreas Meyer b454b3febd manual cleanup:
* .C ---> .cpp
* removed ../examples from paths
* moved some demo/example files out of doc_tex into their respective place
* now it should build properly, again
2006-08-07 16:43:09 +00:00
Laurent Saboret 8bad984bbb Fixed links/labels in html (as requested by AM) 2006-05-19 10:21:11 +00:00
Sylvain Pion 5bed014d27 Levy -> L\'evy 2006-05-04 13:55:08 +00:00
Andreas Fabri 8a73f56293 Removed \section{Alphabetical....} 2006-04-18 09:15:48 +00:00
Laurent Saboret 8e580271d5 Minor changes due to switch to generate_reference_manual version 0.7 2006-04-10 13:06:00 +00:00
Laurent Saboret 5b2d379a39 Removed extra spaces in methods declaration to improve cgal_manual matching (as requested by AM) 2006-04-07 11:13:23 +00:00
Andreas Meyer 5b5a60cecf rewritten the whole manual
ok. seriously:

renamed \chapter into \ccUserChapter and \ccRefChapter
2006-04-06 17:03:37 +00:00
Laurent Saboret 5865ded27f Feature requested by MK and AM: wrap types, functions and variables name with \ccc. 2006-04-06 12:23:33 +00:00
Andreas Fabri 8501581a2d cleanup of \sections 2006-04-05 14:05:51 +00:00
Laurent Saboret 93749c2f10 Remove obsolete files 2006-04-04 10:13:16 +00:00
Laurent Saboret 86adba238c Clarify documentation about symmetric/asymmetric matrices 2006-03-20 11:22:05 +00:00
Andreas Meyer d76e064ac0 some FIXME notes 2006-03-19 16:54:42 +00:00
Laurent Saboret ca33a2d68f Huge optimization! Filling a TAUCS matrix is about 100 times faster 2006-03-13 09:43:26 +00:00
Laurent Saboret 7a1b3fbadf Removed obsolete comments 2006-03-10 10:38:20 +00:00
Laurent Saboret 6423e03ef1 Fixed misspellings and other tiny errors 2006-03-10 09:26:27 +00:00
Laurent Saboret 2d7dbed6da Large changes of the user manual requested by MK:
- added paragraph about exact arithmetic and algorithmic complexity (BL)
- concepts are now described at the begining of the user manual
- mesh cutting is better explained (picture provided by PA)
- improved description of available solvers
- reference pages are listed thematically in the reference manual
- Fixed UML diagrams in Software Design section

Other changes requested by PA:
- pictures of algorithms output in 2D (EPS)
2006-03-09 17:15:04 +00:00
Laurent Saboret 05939a56b8 Removed not-yet-implemented features (as requested by MK):
- border parameterization on any convex polygon
- check matrix conditioning
2006-03-06 15:33:44 +00:00
Laurent Saboret c7dfff5de9 Removed not-yet-implemented features (as requested by MK) 2006-03-06 14:14:28 +00:00
Laurent Saboret d83784ed18 Replaced 'one to one' and '1 to 1' by 'one-to-one' (as requested by MK) 2006-03-06 13:32:35 +00:00
Laurent Saboret 6d42e60266 Removed examples from reference manual (as requested by MK) 2006-03-06 12:18:58 +00:00
Laurent Saboret ce3a61b9fc Added template parameters to class names (as requested by MK).
Also added \ccRefPageBegin..\ccRefPageEnd pairs.
2006-03-06 11:07:47 +00:00
Laurent Saboret 59dc779edf Added templates parameters 2006-03-03 15:48:38 +00:00