Sébastien Loriot
ea240cfac5
use \PkgXXX instead of \PkgXXXSummary
2018-10-08 10:28:44 +02:00
Sébastien Loriot
a2e8a1c68f
add the suffix Ref to doxygen link to reference
2018-10-08 10:26:56 +02:00
Sébastien Loriot
19adf3b05e
make the doc match struct/class with the implementation
2017-11-17 11:34:55 +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
88c0db55ca
Empty example paths should not result in warnings
2015-12-10 17:00:26 +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
c97774778f
add missing dots
2015-02-12 09:14:08 +01:00
Sébastien Loriot
e62e2ce94f
add a deprecation notice in the doc of Convex_hull_d
2015-02-12 08:35:22 +01:00
Laurent Rineau
38e5dc102d
Remove execution permissions
2013-11-13 14:05:43 +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
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
08c9214275
doc: last replacements of \R by \mathbb{R}
2013-07-11 07:29: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
d4e379ba82
Small fixes in the generated Doxyfile.in
2013-05-30 15:32:33 +02:00
Philipp Möller
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
Sébastien Loriot
3c7ad8410c
add classified reference manual pages
2013-03-12 15:07:19 +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
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
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
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
Andreas Fabri
f4cad2f29d
cleanup
2012-10-10 20:00:13 +00:00
Andreas Fabri
b8b7a5dad3
get rid of spurious XX
2012-10-03 17:02:54 +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
b64ba48134
The changes to move the package overview labels into the
...
PackageDescription.
2012-09-25 17:17:49 +00:00
Philipp Möller
e54098fb57
Throw out left over Classified files and move their content if
...
necessary.
2012-09-20 16:29:19 +00:00
Philipp Möller
1954eff3d6
* build normalized mainpage anchors
...
* better naming for Pkg commands
* User and Reference Manual links from the PackageOverview
2012-09-20 15:30:03 +00:00
Andreas Fabri
6f61e2b2ee
Downsize headings
2012-09-17 14:53:05 +00:00
Andreas Fabri
0988d51b3c
add placeholder for teaser
2012-08-30 12:45:31 +00:00
Philipp Möller
5a0a5403c4
Enable autotoc on mainpages
2012-08-29 15:45:17 +00:00
Andreas Fabri
82dbdee593
backquote \hasModel
2012-08-29 08:51:26 +00:00
Andreas Fabri
6bd54579e2
cleanup
2012-08-28 19:19:40 +00:00
Philipp Möller
e2616dafb1
Rebuild the how_to_cite structure
2012-08-28 17:33:45 +00:00
Andreas Fabri
af87732f6a
Add \anchor of chapters
2012-08-21 10:18:58 +00:00
Andreas Fabri
3dfd7031c2
Remove whitespace
2012-08-20 18:30:46 +00:00
Philipp Möller
d3a9a641de
Refurb package descriptions with a label for the license.
2012-08-20 14:28:36 +00:00
Philipp Möller
6a45864c1a
Throw a set of ported doc files under version control
2012-08-09 16:07:44 +00:00