Commit Graph

85 Commits

Author SHA1 Message Date
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 42b9a0be04 fix level 2019-02-14 10:26:05 +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
Guillaume Damiand 8a0dc2f279 Add one draw example in each user manual. 2018-05-29 11:11:49 +02:00
Guillaume Damiand 8018675aef Update package description 2018-05-29 11:11:49 +02:00
Guillaume Damiand fb95a8e0d9 Add doc for draw 2018-05-29 11:11:49 +02:00
Guillaume Damiand ff586425af All 4 new examples to illustrate the usage of CGAL::draw. 2018-05-29 11:11:49 +02:00
Guillaume Damiand ddfb8204dc Add figures for all the basic viewers. 2018-05-29 11:11:49 +02:00
Sébastien Loriot 4324ff9375 fix links 2017-06-30 18:13:42 +02:00
Andreas Fabri 388a7678e6 Add an undocumented manipulator which allows operator<< to dispatch OFF, PLY, etc 2017-06-30 18:13:40 +02:00
Andreas Fabri f9827278a2 Document read_off(), and write_off() for Polyhedron_3 and Surface_mesh 2017-06-30 18:12:14 +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 b0bbbe05f6 Add \pre 2016-11-28 11:23:48 +01:00
Andreas Fabri 18488fa0e0 Update Polyhedron_3.h 2016-02-26 20:51:25 +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 0ad467b321 Use generic example directories 2015-12-10 17:05:53 +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 6d5a92ebcb try to improve cgalRequires removal 2015-11-23 22:06:06 +01:00
Maxime Gimeno 7b4267c162 Replacement of cgalRequires
-fix for #291
2015-11-23 22:06:06 +01:00
Sébastien Loriot b0ade22ea9 more precision about the plane in the facet of the polyhedron 2015-11-23 16:12:57 +01:00
Sébastien Loriot 3e509ce564 fix typo in doc 2015-10-22 11:38:18 +02:00
Andreas Fabri 6c81226831 improve wording in the manual 2015-06-22 12:40:44 +02:00
Andreas Fabri 98e160e998 Polyhedron_3::..._handle are model of Hashable 2015-05-27 11:36:02 +02:00
Sébastien Loriot f7cad6db65 bug in the doc of Polyhedron_3::split_edge inducing a bug in Euler::split_edge 2014-07-24 13:26:36 +02: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 dc7aca42ce trivial doc enhancement 2013-11-28 17:29:41 +01:00
Laurent Rineau 4e5734b222 Improve doc of concepts Vertex and Face of HDSItems and PolyhedronItems 2013-09-16 15:04:19 +02:00
Sébastien Loriot 9c2f35ed1a using cgalHeading instead of h3 2013-08-07 10:06:49 +02: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
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +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
Ross Hemsley c0690f87f4 Manually inserted tags that could not be generated automatically
added in options that were in XML but were not moved across to new Doxyfile.in files.
2013-05-30 14:45:18 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot 170c619a2d fix places where the <div> added by cgalAdvanced conflicts with other html tags 2013-05-28 09:51:49 +02:00
Sébastien Loriot 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Laurent Rineau 7985785781 Fix the citations to VRML. vrml.org is no longer. 2013-04-23 14:06:52 +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 b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Sébastien Loriot 147c46a15a \cgalHeading{Note} --> \note in documentation 2013-01-07 18:24:33 +01:00
Sébastien Loriot 5ec28b1cf4 replacing the usage of section in user man by \cgalHeading macro call 2013-01-07 18:04:37 +01:00