Commit Graph

64 Commits

Author SHA1 Message Date
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
Simon Giraudot af8e73750c Merge branch 'CGAL-Solver-package-GF-old' into CGAL-Solver-package-GF 2015-08-20 11:51:34 +02:00
Andreas Fabri 61107c15d7 improve the example in Ridges.txt (that is nothing that gets compiled) 2015-05-28 11:04:18 +02:00
Andreas Fabri a18ba6607a polish 2015-04-14 16:23:23 +02:00
Sébastien Loriot 3c60a3425b fix doc warning 2015-04-14 16:16:48 +02:00
Andreas Fabri 18f07524fe polish 2015-04-14 16:05:58 +02:00
Andreas Fabri 6bfff35207 typo 2015-04-14 15:18:31 +02:00
Andreas Fabri 71c8510de8 Use \pre 2015-04-14 15:09:36 +02:00
Andreas Fabri b6290d0ca1 add backquotes 2015-04-14 14:57:07 +02:00
Andreas Fabri df7bcccdc0 change several package descriptions 2015-04-14 11:21:16 +02:00
Andreas Fabri 67bb10fb27 Tag_3 does not exist in the code 2015-03-17 14:17:26 +01:00
Andreas Fabri c2445753d2 improve params 2015-03-17 10:46:13 +01:00
Andreas Fabri 0a90521e5d improve manual 2015-03-13 09:13:35 +01:00
Andreas Fabri eed907fac7 remove a concept 2015-03-13 09:03:18 +01:00
Andreas Fabri 91902b9dda improve manual 2015-03-13 09:01:50 +01:00
Andreas Fabri b9f0487cf9 improve ref manual 2015-03-12 21:54:04 +01:00
Andreas Fabri 9ec3439ea3 improve ref manual 2015-03-12 21:50:20 +01:00
Andreas Fabri df6fc3dca3 simplifications 2015-03-12 18:00:18 +01:00
Andreas Fabri 767e0efad3 cleanup 2015-03-12 11:01:56 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Sébastien Loriot e8975dbac7 function documentation fixes
remove the repetition of the name of the function in its brief description
 add parenthesis for function matching "function\s+`[a-z0-9_]`"
2013-09-03 14:25:50 +02:00
Andreas Fabri fc8fd13927 Add () after function names to increase readability. 2013-08-21 12:36:53 +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 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 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 7412cdb650 add all property maps concepts to ease linking to them. Update pages using them 2013-03-14 16:59:27 +01: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 5ec28b1cf4 replacing the usage of section in user man by \cgalHeading macro call 2013-01-07 18:04:37 +01:00
Sébastien Loriot 7e095c7a7a Merge branch 'Documentation-flat-ref-manual-pmoeller' 2013-01-04 15:19:57 +01:00
Sébastien Loriot bb6f214b57 let doxygen collecting global functions and classes 2013-01-04 14:45:17 +01:00
Sébastien Loriot 86d1e591ee Revert "Classified ref man for Ridges_3"
This reverts commit 9642eb734f.
The flat view is not better
2013-01-04 14:41:03 +01:00
Andreas Fabri ab362ab886 polish Ridges 2012-12-28 19:58:07 +01:00
Andreas Fabri cd838d1ccf polish Ridges 2012-12-28 19:58:06 +01:00
Philipp Möller 9642eb734f Classified ref man for Ridges_3 2012-12-19 12:36:29 +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
Andreas Fabri aa61332278 fix typos and links 2012-11-29 17:58:40 +01:00
Andreas Fabri 29b8bfb5eb Better anchors + package dependency 2012-11-29 15:45:06 +01:00
Sébastien Loriot 469f179d9e subsection should be section 2012-11-26 09:50:38 +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 59877a8d52 linking and unlinking 2012-10-30 13:40:03 +00:00
Sébastien Loriot 8011783e11 merge from next and update doxygen doc 2012-10-19 17:18:55 +00:00