Commit Graph

29 Commits

Author SHA1 Message Date
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Sébastien Loriot 829c412b10 move note outside the brief 2019-01-14 17:53:40 +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 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
Sébastien Loriot 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Sébastien Loriot f2d0cc34cd add implementation note in template alias declaration 2013-01-24 11:24:40 +01:00
Sébastien Loriot 35c64e2f46 using template alias declaration to inline a nested class 2013-01-24 08:27:33 +01:00
Sébastien Loriot 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +01:00
Sébastien Loriot e313ce4397 using backticks to link in see also 2013-01-08 17:50:29 +01:00
Sébastien Loriot 844049e152 remove warning about linking issue 2013-01-04 10:55:01 +01:00
Sébastien Loriot 33520145b2 replace \sa \ref ::FOO by \sa `FOO`
using:
 perl  -pi -e 's/\\sa\s+\\ref\s+::([A-Za-z0-9_:]+)\s*/\\sa `$1`\n/'
2012-11-23 09:26:11 +01:00
Sébastien Loriot 4fa2db4a48 change \sa ::FOO into \s `FOO`
using:
perl  -pi -e 's/\\sa\s+::([A-Za-z0-9_:]+)\s*/\\sa `$1`\n/'
2012-11-23 09:18:35 +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
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Andreas Fabri cdb575ab5d polished 2012-10-24 19:22:05 +00:00
Andreas Fabri 3977130f7e de-math or \mathrm 2012-10-23 17:10:44 +00:00
Andreas Fabri a74d6301d0 fix refines; linking; typos 2012-10-23 13:33:49 +00:00
Andreas Fabri 80012fa6b1 Add classified.txt 2012-10-22 16:07:17 +00:00
Philipp Möller 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller 1327c54ebc Fix tables containing \models clauses 2012-09-12 10:47:16 +00:00
Philipp Möller 314b75111a fix rebind 2012-09-11 15:18:08 +00:00
Andreas Fabri c998e9b6a7 fix a table 2012-09-11 14:54:38 +00:00
Philipp Möller bf029a7f3d Add polynomial doc 2012-09-10 16:51:31 +00:00