Commit Graph

140 Commits

Author SHA1 Message Date
Andreas Fabri f6f52e01b0 cleanup and fix of Simple_parameterization.cpp 2017-06-22 16:12:26 +02:00
Andreas Fabri d4bdc3a8f9 WIP doc 2017-06-22 16:12:26 +02:00
Andreas Fabri 9cc84e828c Add an initial User Manual section for Seam_mesh 2017-06-22 16:12:26 +02:00
Andreas Fabri a348af1d61 WIP on doc 2017-06-22 16:11:38 +02:00
Andreas Fabri 5a23256c13 wip 2017-06-22 16:11:38 +02:00
Andreas Fabri f0f6575c76 WIP on the doc 2017-06-22 16:11:38 +02:00
Andreas Fabri afc6476992 start rewriting the doc 2017-06-22 16:11:38 +02:00
Maxime Gimeno a01593e0bb Unify the links to the Polyhedron demo in the package descriptions. 2017-01-10 14:56:52 +01:00
Andreas Fabri 8f796bb4b6 missed one 2016-02-17 16:41:05 +01:00
Andreas Fabri 51920f6b86 Unify chapter names 2016-02-17 16:35:48 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Philipp Möller 71b4e9c515 Use CGAL_FULL_VERSION in all Doxyfile.in 2015-12-17 16:33:28 +01:00
Philipp Möller 79b7fc5081 Handle the INPUT cases where the whole include dir is used 2015-12-10 17:03:46 +01:00
Sébastien Loriot a1279bc063 update dependencies 2015-09-21 08:43:05 +02:00
Simon Giraudot 09f3659353 Improving doc 2015-09-02 15:40:30 +02:00
Simon Giraudot af8e73750c Merge branch 'CGAL-Solver-package-GF-old' into CGAL-Solver-package-GF 2015-08-20 11:51:34 +02:00
Sébastien Loriot 02a98c3ca4 bugfix: add missing concept for solving normal equation 2015-07-09 17:22:27 +02:00
Andreas Fabri 674159d412 fixes of doxygen warnings/errors 2015-04-14 14:37:42 +02:00
Sébastien Loriot ea96055ba9 use examples.txt at the root of the doc package dir 2015-04-14 11:52:22 +02:00
Andreas Fabri 90e6fbb979 remove example as Eigen is now the default 2015-04-14 11:31:06 +02:00
Andreas Fabri df7bcccdc0 change several package descriptions 2015-04-14 11:21:16 +02:00
Andreas Fabri 8ae42933c7 Do not explain OpenNL and say that LSCM has no parameter for a solver 2015-04-13 16:37:40 +02:00
Andreas Fabri 83f1d1b29a move files 2015-03-25 08:57:00 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Sébastien Loriot 3ef9efb0ef pre-factor -> factor 2014-02-17 09:56:37 +01:00
Sébastien Loriot e242bc885c Eigen_solver_traits become a model of SparseLinearAlgebraTraitsWithPreFactor_d 2014-02-14 14:51:33 +01:00
Sébastien Loriot d282ade623 use \cgalCite instead of \cite
using perl -i -pe 's/\\cite\s*{?([a-zA-Z0-9:-]+)}?/\\cgalCite{$1}/g'
2013-08-05 18:25:26 +02:00
Sébastien Loriot b2ef3b8673 Merge branch 'doc-remove_gif-local'
Successfully test in CGAL-4.3-Ic-102

This commit fixes a few issues in the doxygen documentation and in particular
the figure for the generation of latex doc.

Approved by the interim release manager

xplain why this merge is necessary,
2013-07-26 17:50:07 +02:00
Sébastien Loriot 2dfe8a3d73 workaround for a doxygen bug: remove space after /!* to avoid a verbatim env
this happens if you have an empty line or the text directly after /!*
to find them in the generated documentation, grep for "pre class=\"fragment\""
(a few of them are legitimate however)
2013-07-25 14:58:53 +02:00
Sébastien Loriot 74a1ac055e remove pdf files from doxygen doc include path 2013-07-25 11:15:18 +02:00
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Philipp Möller 895245426a Fix some errors introduced by adding the titles 2013-05-30 18:09:42 +02:00
Ross Hemsley 4d9caf3763 Added names that were missing into the Doxyfile.in entries.
Also modified Installation/CMakeLists.txt to push the version number variable to the parent level
so that it can be accessed by the documentation
2013-05-30 17:55:43 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot 2ac05c6d95 fix warnings detected by doxygen 1.8.4 2013-05-24 12:49:02 +02:00
Alexandros Konstantinakis-Karmis 3b1d281efb Abbreviations trigger end of \brief description
Fixes bug #15482:
https://gforge.inria.fr/tracker/index.php?func=detail&aid=15482&group_id=52&atid=13845
2013-03-13 11:58:56 +01:00
Sébastien Loriot e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Sébastien Loriot 571f782910 remove extra . 2013-01-02 15:44:57 +01:00
Andreas Fabri 54a9101463 polish Mesh_3 2012-12-28 11:26:28 +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
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
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Sébastien Loriot 691950a973 fix user and ref main pages 2012-10-22 15:44:23 +00:00
Sébastien Loriot e7780a8b30 fix eigen wrapper doc 2012-10-22 15:43:46 +00:00
Sébastien Loriot 0dfa117281 regenerate concepts using Phillip's tool
make vector and matrix nested classes
2012-10-22 15:43:04 +00:00
Sébastien Loriot b4724242d1 remove taucs dependency 2012-10-19 17:30:09 +00:00
Sébastien Loriot 284bac7a38 add Eigen wrappers doxygen doc 2012-10-19 17:20:27 +00:00
Sébastien Loriot 59b4985eab work on concept 2012-10-19 17:03:17 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Sébastien Loriot 9da7cc390f remove some taucs+enhance look 2012-10-19 15:22:31 +00:00
Andreas Fabri 4d77463415 No need for 3rd party OpenNL 2012-10-18 11:53:12 +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 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
Philipp Möller 8feb3c58b5 Change folder layout to match the general scheme. 2012-09-24 09:55:59 +00:00
Andreas Fabri b7e754923a polish 2012-09-24 09:52:38 +00:00
Philipp Möller e54098fb57 Throw out left over Classified files and move their content if
necessary.
2012-09-20 16:29:19 +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
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Andreas Fabri bb9b9f1840 link, unlink 2012-09-14 15:54:30 +00:00
Andreas Fabri 03c9ef21fc less state-of-the-art 2012-09-14 15:34:42 +00:00
Andreas Fabri af2b0c2faf many changes 2012-09-14 14:51:04 +00:00
Philipp Möller 5bed1b15c5 Add basic Surface_mesh_parameterization, grouping and some moves to
internal are still missing
2012-09-14 11:15:18 +00:00
Laurent Rineau 8f59fd9592 Turn QPL into LGPLv3+ 2012-01-13 16:33:35 +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 1d95e936d2 Optimization of speed and memory footprint 2008-10-13 08:34:19 +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 3a29a3f61f generate_reference_documentation 1.0.2 requires to document the concepts refinement by inheritance instead of "@heading Refines" 2008-04-04 16:38:18 +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 7c2497c5d0 More spell checking 2007-04-23 12:11:29 +00:00
Laurent Saboret 258df72389 Fixed 2 crashing bugs in Parameterization_mesh_patch_3 (see fork.off and butterfly-2faces.off).
Added is_valid to ParameterizationMesh_3 concept.
Added back traces (if DEBUG_TRACE is defined).
2006-12-08 16:12:22 +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 8e580271d5 Minor changes due to switch to generate_reference_manual version 0.7 2006-04-10 13:06:00 +00:00
Laurent Saboret 86adba238c Clarify documentation about symmetric/asymmetric matrices 2006-03-20 11:22:05 +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 d2777b879a Changed pointers to mesh to references all over the package (as requested by MK) 2006-03-03 09:33:29 +00:00
Laurent Saboret 880ece127c Rename Parameterization package as Surface_mesh_parameterization 2006-03-01 16:43:35 +00:00