Commit Graph

71 Commits

Author SHA1 Message Date
Mael Rouxel-Labbé 16092f53d6 Update doc about NPs 2020-04-05 17:56:11 +02:00
Mael Rouxel-Labbé fc79510388 Regroup NP aliases into the base doxyfile.in 2020-04-04 17:26:32 +02:00
Sébastien Loriot 59bc453b42 first batch of replacement for level 1 in classified ref man
command used:
grep -l  "##" */doc/*/PackageDescription.txt | xargs  sed -i  -E 's/\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\s*$/\\cgalCRPSection{\1}/'
2019-02-14 10:32:39 +01:00
Sébastien Loriot 3a1516e940 add missing Reference and uniformize ref man group declaration 2018-11-20 13:47:16 +01:00
Sébastien Loriot 2f9408f867 rename link name to match package name 2018-10-08 10:28:55 +02:00
Sébastien Loriot ea240cfac5 use \PkgXXX instead of \PkgXXXSummary 2018-10-08 10:28:44 +02:00
Sébastien Loriot a2e8a1c68f add the suffix Ref to doxygen link to reference 2018-10-08 10:26:56 +02:00
Laurent Rineau 61e662c4e4 Merge pull request #2649 from sgiraudot/BGL-Regroup_named_parameters-GF
Regroup PMP named parameters with BGL named parameters

# Conflicts:
#	Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/internal/parameters_interface.h
2017-12-19 16:33:44 +01:00
Sébastien Loriot 6342f9a732 fix remaining point reference 2017-12-12 14:41:41 +01:00
Sébastien Loriot 2a90e40211 add missing template parameters 2017-12-12 14:26:35 +01:00
Sébastien Loriot 471d996e33 remove paragraph no longer relevant 2017-12-12 11:24:01 +01:00
Mael Rouxel-Labbé ad947da752 Give each package a NamedParameters.txt 2017-12-12 00:07:57 +01:00
Sébastien Loriot d8bba16568 update user manual to also used named parameters 2017-12-11 18:03:36 +01:00
Sébastien Loriot 8cf200f6b0 improve phrasing 2017-09-08 08:38:33 +02:00
Sébastien Loriot c3833d0fb0 update border_node for Sqrt3
only one function that computes the coordinates of the interior points
and the update of the target vertex. We also make the function consistant
with other masks by requesting a non boundary halfedge
2017-09-07 15:57:45 +02:00
Sébastien Loriot b750ca7f0f update the document to be more precise 2017-09-07 14:43:28 +02:00
Andreas Fabri 3cc699504f fix release date 2017-05-12 11:01:33 +02:00
Mael Rouxel-Labbé 2cd54cd380 Removed obsolete and broken INPUT definition from doxygen.in 2017-05-12 10:34:56 +02:00
Mael Rouxel-Labbé 7982f9ea68 Restructured the subdivision package
-- Integrated the doc in the header files
-- Split and moved files to have a proper internal structure and to distinguish
   between hosts, stencils and methods at the filename level.
-- Removed all instances of Polyhedron to have PolygonMesh instead
-- Cleaned off useless functions (Polyhedron_decorator remnants)
-- Improved general documentation
-- Minor performance improvements
2017-05-12 10:34:56 +02:00
Mael Rouxel-Labbé 22d47f32b8 Updated the documentation 2017-05-12 10:34:56 +02:00
Andreas Fabri 7762927ed1 Use svg files 2017-05-12 10:34:56 +02:00
Andreas Fabri f996c8b664 Add svg files 2017-05-12 10:34:56 +02:00
Andreas Fabri 3b5c631aa9 polish 2017-05-12 10:34:56 +02:00
Andreas Fabri c02b755e27 Complete the testsuite, and fix errors it revealed 2017-05-12 10:34:56 +02:00
Andreas Fabri 3de1756a6a Generalize documentation 2017-05-12 10:34:56 +02:00
Sébastien Loriot 075db398c7 fix linking 2017-05-12 10:34:56 +02:00
Andreas Fabri 363413c723 polish 2017-05-12 10:34:56 +02:00
Andreas Fabri 5a0d3cd210 polish 2017-05-12 10:34:56 +02:00
Andreas Fabri 76d2fcf7a5 polish 2017-05-12 10:34:56 +02:00
Andreas Fabri b74b3b754e The user manual should be ok now 2017-05-12 10:34:56 +02:00
Andreas Fabri 8af4f2b433 document a first function with named parameters 2017-05-12 10:34:56 +02:00
Andreas Fabri 594a5a0a58 There are no such concepts or models with _stencil 2017-05-12 10:34:56 +02:00
Andreas Fabri 813cb94b8b WIP for the doc 2017-05-12 10:34:56 +02:00
Andreas Fabri 8023aa3d01 Start changing the manual 2017-05-12 10:34:56 +02:00
Andreas Fabri 511197ebd9 Start changing the manual 2017-05-12 10:34:56 +02:00
Maxime Gimeno a01593e0bb Unify the links to the Polyhedron demo in the package descriptions. 2017-01-10 14:56:52 +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 81a8f982dc Handle the easy INPUT cases
If INPUT is just PKG/doc/PKG, handle it automatically.
2015-12-10 17:00:26 +01:00
Sébastien Loriot 9114db9085 restore figure source files removed in 0fa2cacb
| commit 0fa2cacb60
  | Author: Sébastien Loriot <sebastien.loriot@cgal.org>
  | Date:   Tue Dec 3 17:27:02 2013 +0100
  |
  |     remove doc_tex documentation (including developer manual) and old manual tools
2014-02-10 14:54:23 +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 143a2181b3 add latex format for \imagei doxygen command
perl -pe 's/^(\s*)\\image\s+html\s+(.*)\s*$/$1\\image html $2\n$1\\image latex $2\n/' -i
2013-07-25 11:50: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 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +02:00
Sébastien Loriot 4389b0bac8 remove the usage of gif in the doxygen doc as pdflatex does handle them
replace the files with png
2013-07-25 11:06:13 +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