Commit Graph

69 Commits

Author SHA1 Message Date
Sébastien Loriot 19adf3b05e make the doc match struct/class with the implementation 2017-11-17 11:34:55 +01:00
Mael Rouxel-Labbé fba90bcd32 Fixed segment Delaunay graph concepts
SDG inherits from T2, so the concepts must refine T2's
2017-06-28 10:15:30 +02:00
Andreas Fabri cd4457407b Fix typo 2016-03-04 17:31:32 +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
Andreas Fabri b3ed4b933a The class Segment_Delaunay_graph_without_intersections_2 does not exist 2015-10-13 15:47:30 +02:00
Andreas Fabri c37ffa6613 use typedef not derivation 2015-04-29 11:58:02 +02:00
Andreas Fabri 6737e8e43b use figure macros 2015-04-29 11:58:02 +02:00
Andreas Fabri d6d5471161 boolean -> Boolean 2015-04-29 11:58:02 +02:00
Andreas Fabri 4a15ac8795 prefix classes with CGAL when outside the namespace CGAL 2015-04-29 11:58:01 +02:00
Andreas Fabri 362c962446 use \tparam 2015-04-29 11:58:01 +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
Laurent Rineau 38e5dc102d Remove execution permissions 2013-11-13 14:05:43 +01: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 ba4df29448 add examples using spatial sorting 2013-07-05 12:00:09 +02:00
Sébastien Loriot 6484c6e6da typo 2013-07-02 19:59:57 +02:00
Sébastien Loriot 72f117839f update the insert function to dispatch according to the value-type 2013-07-02 19:51:34 +02:00
Sébastien Loriot 1aa8ab8afa add function to insert a range of segments 2013-07-02 18:49:02 +02:00
Sébastien Loriot 1799dc232a add function to insert a range of segments from points and pairs of indices 2013-07-02 14:35:46 +02:00
Sébastien Loriot b9d1183cd0 add function to insert a range of points using spatial sorting 2013-07-02 11:58:40 +02:00
Sébastien Loriot 2fb80f6520 add Less_x_2 and Less_y_2 in the traits concept and its models
this is needed to use the spatial sorting
2013-07-02 11:57:02 +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
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +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
Sébastien Loriot 5f3c8826d1 h2 is the first header in classified reference manuals 2013-01-07 09:00:48 +01:00
Sébastien Loriot 7e095c7a7a Merge branch 'Documentation-flat-ref-manual-pmoeller' 2013-01-04 15:19:57 +01:00
Sébastien Loriot 8daada2ce6 start classified ref man at h1 2013-01-04 14:59:28 +01:00
Sébastien Loriot 9631c3444c name link to chapters 2013-01-02 23:00:56 +01:00
Andreas Fabri bfbc28cabf polish Segment Delaunay Graph 2012-12-28 19:58:08 +01:00
Philipp Möller 872390f452 Add the classified ref to Segment_delaunay 2012-12-19 12:36:33 +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 ae8362b7d6 replace \cgalModels ::FOO by \cgalModels `FOO`
using:
 perl  -pi -e 's/\\cgalModels\s+::([A-Za-z0-9_:]+)\s*$/\\cgalModels `$1`\n/'
2012-11-23 09:37:53 +01:00
Sébastien Loriot d3c4e9b5e6 remove documentation warnings 2012-11-19 16:19:09 +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 510019c81f No need for CGAL:: 2012-11-04 12:59:17 +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
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00