Commit Graph

54 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
Sébastien Loriot c675a2ee91 fix incorrect link to figure and use italic instead of MathJax 2017-08-08 11:08:50 +02:00
Olivier Devillers 3f5af4219d bug fix in doc spatial_sorting 2016-03-07 14:22:12 +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 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
Pedro Machado Manhães de Castro 7a54cf0b68 work -> workS 2014-03-27 10:44:25 -03:00
Pedro Machado Manhães de Castro 8c42eaf8cf stillS -> still 2014-03-27 10:33:48 -03:00
Pedro Machado Manhães de Castro eb6cc60fcb Improving the text 2014-03-25 14:36:26 -03:00
Pedro Machado Manhães de Castro 9c23e46665 2nd review of Monique 2014-03-25 14:22:03 -03:00
Pedro Machado Manhães de Castro 47441076ec updating according to Monique's review; see Small Feature section 2014-03-20 10:36:03 +01:00
Pedro Machado Manhães de Castro ce806983a5 updating the doc with the changes of design 2014-03-06 16:20:37 +01:00
Pedro Machado Manhães de Castro 0912ac19b2 quick fix in the doc nb 2 2014-03-05 14:40:56 +01:00
Pedro Machado Manhães de Castro c8e6d323c1 quick fix in the doc 2014-03-05 14:30:20 +01:00
Pedro Machado Manhães de Castro d69f940b37 updating the doc for the hilbert sort on the sphere 2014-03-05 14:27:11 +01:00
Pedro Machado Manhães de Castro 9a68f401ae User manual update + spherical_* -> *_on_sphere 2014-03-04 17:53:41 +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
Sébastien Loriot 2b30ba0337 no backtick in tparam 2013-03-14 17:25:29 +01: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
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 7e406d0fe8 fix warning about missing link 2013-01-04 10:58:11 +01:00
Sébastien Loriot 1eefcc46e7 more grouping 2013-01-04 10:58:07 +01:00
Andreas Fabri e99812ca50 polish spatial_sorting 2012-12-28 17:46:06 +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 834dd92263 special cases for replacing \cgalModels ::FOO by \cgalModels `FOO` 2012-11-23 09:42: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 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 f7bd575b2c linking 2012-10-30 13:01:20 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Philipp Möller 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +00:00
Philipp Möller c9fdbf3edb Add an anchor to each level one heading, so we get a nice tree in the
user manuals.
2012-10-02 11:53:01 +00:00
Philipp Möller 37778547bf Fix example to point to paths similar to a flat layout 2012-10-01 18:02:44 +00:00
Philipp Möller 33cd9af6cd Remove the last remnants of \require and turn them into \requires 2012-10-01 14:56:32 +00:00
Philipp Möller b64ba48134 The changes to move the package overview labels into the
PackageDescription.
2012-09-25 17:17:49 +00:00