Commit Graph

60 Commits

Author SHA1 Message Date
Sébastien Loriot 742a615527 fix doc warnings triggered essentially by the improvement of doxygen 2018-04-25 23:36:21 +02:00
Laurent Rineau 7e9f756935 Replace all std::unary_function by CGAL::unary_function 2017-10-04 15:57:09 +02:00
Mael Rouxel-Labbé 9a5e0f8a64 Modified gradient fitting concept 2017-09-13 16:24:47 +02:00
Mael Rouxel-Labbé d0749f1d53 Minor doc fixes 2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 1fc2282350 Fixed regular triangulation capitalization across CGAL 2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 9fbf2720ce Annihilated Regular_triangulation_euclidean_traits_23 across all packages
Left a little bit alive in the tests and in the Triangulation_23/doc
2017-06-28 10:15:30 +02:00
Mael Rouxel-Labbé d3d63b579a Corrected documentation of Voronoi_intersection_2_traits_3
-- the traits class is not a model of InterpolationTraits
-- plenty of typedef that were not documented
-- added new requirements due to changes in points/weighted_points
-- constructor with a kernel parameter
2017-06-28 10:14:35 +02:00
Andreas Fabri 490949efa7 fix Interpolation package 2016-11-16 09:58:23 +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 ea96055ba9 use examples.txt at the root of the doc package dir 2015-04-14 11:52:22 +02:00
Andreas Fabri ade01f02b4 fix typos 2015-03-12 11:56:29 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +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 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
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +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 3c7ad8410c add classified reference manual pages 2013-03-12 15:07:19 +01:00
Sébastien Loriot eca25c4717 add missing parameter in interpolation documentation 2013-01-31 18:07:22 +01:00
Andreas Fabri 3e74389896 typos 2013-01-30 17:31:44 +01:00
Andreas Fabri 03c5412f93 switch to \tparam and \param in the Interpolation package 2013-01-30 17:15:13 +01:00
Andreas Fabri 19a3cc48fd polish doc in Interpolation 2013-01-17 18:05:41 +01:00
Andreas Fabri ca27d04e4d fix typo 2013-01-15 12:35:19 +01:00
Andreas Fabri ae50be5697 cleanup 2013-01-11 13:01:40 +01:00
Andreas Fabri bfea719a1f de-math 2013-01-11 12:46:15 +01:00
Andreas Fabri 682f09ab8c subsection -> subsubsection 2013-01-11 11:04:19 +01:00
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Sébastien Loriot 3cc7c5871f renaming groups of global functions for Interpolation and releated changes 2013-01-09 09:36:41 +01:00
Sébastien Loriot 11db34df21 this file is not officially documented 2013-01-09 09:33:59 +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 42d15a11d0 using uniform markups in classified reference pages 2013-01-04 15:16:40 +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 d585f5080e subsection is actually a section 2012-11-19 16:21:42 +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 0e2b61845c replace markup #, ##, ### by \section, \subsection and \subsubsection
(manual replacement)
2012-11-06 22:24:02 +00:00
Sébastien Loriot ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection
(script replacement)
2012-11-06 22:02:15 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 88a2f0d2db Fix a few warnings 2012-10-09 17:09:25 +00:00
Andreas Fabri 5dd82a1b37 finished 2012-10-09 14:25:17 +00:00