Commit Graph

289 Commits

Author SHA1 Message Date
iyaz 30a63a57c6 User manual updates 2013-04-30 18:28:13 +03:00
Sébastien Loriot e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Philipp Möller 75f69570dc Change the titles of mainpages to "User Manual"
This leads to a slightly odd result in the search for "User Manual",
but makes the pages themselves more consistent.
2012-12-13 14:47:09 +01:00
Andreas Fabri aa61332278 fix typos and links 2012-11-29 17:58:40 +01:00
Sébastien Loriot 8d741d504d remove % in section name 2012-11-14 16:10:15 +01:00
Sébastien Loriot 128b02abb8 update CGAL custom doxygen macros
corresponds to a run of the script Documentation/conversion_tools/rename_macros.sh
+manual edit of doxyassist.xml and pkglist_filter.py
2012-11-14 00:31:05 +01:00
Sébastien Loriot 5ee1081f92 using cgal macros for all figures 2012-11-08 17:17:29 +00:00
Sébastien Loriot ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection
(script replacement)
2012-11-06 22:02:15 +00:00
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Andreas Fabri 9dd1045208 linking unlinking 2012-10-30 13:07:40 +00:00
Philipp Möller 0b10df571d move doc into property_map.h itself 2012-10-23 14:32:10 +00:00
Sébastien Loriot 3f6f20b5c5 fix user man 2012-10-22 22:52:11 +00:00
Sébastien Loriot 495e493ad9 remove taucs 2012-10-22 22:51:55 +00:00
Sébastien Loriot 81d24a0fcf remove fake .h files: the code is already documented with doxygen 2012-10-22 22:51:22 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 6615bcee09 Fix some minor glitches in headings 2012-10-18 12:55:17 +00:00
Philipp Möller 88a2f0d2db Fix a few warnings 2012-10-09 17:09:25 +00:00
Andreas Fabri 95a834708a finished 2012-10-05 13:25:34 +00:00
Andreas Fabri b8b7a5dad3 get rid of spurious XX 2012-10-03 17:02:54 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Philipp Möller 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +00:00
Philipp Möller c9fdbf3edb Add an anchor to each level one heading, so we get a nice tree in the
user manuals.
2012-10-02 11:53:01 +00:00
Philipp Möller 37778547bf Fix example to point to paths similar to a flat layout 2012-10-01 18:02:44 +00:00
Philipp Möller 9d96057636 Add PkgDependsOn to the package summary 2012-09-27 11:13:37 +00:00
Philipp Möller b64ba48134 The changes to move the package overview labels into the
PackageDescription.
2012-09-25 17:17:49 +00:00
Andreas Fabri d8fca76ea1 polish 2012-09-25 11:34:40 +00:00
Andreas Fabri 26f1b6df71 polish 2012-09-24 13:38:55 +00:00
Andreas Fabri bfb3de785a unlinl 2012-09-21 13:50:51 +00:00
Philipp Möller 0aa7cd1c3b Global heading reduction. Rename some Parameter section to Template
Parameters. Fix dependencies.
2012-09-21 09:42:24 +00:00
Philipp Möller bc32209fc9 Remove globally duplicated anchors. 2012-09-20 16:14:23 +00:00
Philipp Möller 1954eff3d6 * build normalized mainpage anchors
* better naming for Pkg commands
* User and Reference Manual links from the PackageOverview
2012-09-20 15:30:03 +00:00
Andreas Fabri b67df505d9 doxygenize \tparam and \param in the free functions 2012-09-20 13:43:17 +00:00
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Philipp Möller 9c213f7604 Add Property_map and Point_set_processing doc 2012-09-17 17:27:48 +00:00
Laurent Saboret 402ef86aef Changes after Surface_reconstruction_points_3/Point_set_processing_3 submission review by AF (7):
Documentation of the new API with property maps.

* The User and Reference Manuals are updated wrt the new API with property maps.
* The examples included in the User and Reference Manuals are updated.

Warning:
* The code of these packages does not match the documentation!
* Do not call generate_reference_manual on these packages. This would remove the new API documentation.

TODO:
* Modify the code to match the documentation.
2009-05-11 16:38:05 +00:00
Laurent Saboret 39552d040f Changes after Surface_reconstruction_points_3/Point_set_processing_3 submission review by AF (5):
Simplified the API:
- removed OrientableNormal_3, PointWithOrientableNormal_3, ReconstructionTriangulation_3, ReconstructionVertexBase_3 concepts.
- classes Orientable_normal_3, Reconstruction_triangulation_3 abd Reconstruction_vertex_base_3 are not documented anymore.
- For free functions provided with 2 variants mutable/non mutable, removed the non mutable one.

TODO:
- remove Orientable_normal_3 class.
- modify mst_orient_normals() to return an iterator over the first non oriented normal.
- fix Poisson MFC demo which does not compile anymore.
2009-04-28 14:10:05 +00:00
Laurent Saboret abeb50070f Changes after submission review by AF (2):
* Moved Lightweight_vector_3 from Point_set_processing_3 to Surface_reconstruction_points_3. It is now undocumented.
* Point_set_processing_3 User Manual does not have a structure of "pipeline" anymore.
* New introduction figures for Surface_reconstruction_points_3 and Point_set_processing_3.
* Deleted poisson.jpg/eps in Surface_reconstruction_points_3.
* INPUT and STEINER constants are now an enum.
* Removed obsolete code:
  - mst_normal_orientation(max_angle)
* PointWithNormal_3::set_position() renamed as position().
* Fixed misspellings.
* and many other improvements to the documentation (and C++ comments).
2009-04-20 16:49:53 +00:00
Laurent Saboret d0ff567259 Split Surface_reconstruction_3 into Point_set_processing_3 and Surface_reconstruction_points_3 (part 1):
* Move/rename files and folders.
* Rename point set IO functions.

Status: 
* Both packages compile on Unix/g++ 4.1.2. The test suite is OK.
* The documentation compiles for both packages.

TODO:
* Update the documentation and package_info
* Update Groviz
* Delete Surface_reconstruction_3
2009-03-13 15:50:14 +00:00
Laurent Saboret cb6e40b653 Split Surface_reconstruction_3 into Point_set_processing_3 and Surface_reconstruction_points_3 (part 1):Move/rename files and folders 2009-03-12 15:16:09 +00:00