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
d4d9bc212b
replace in the doc \R by \mathbb{R}
...
\R is not a valid latex command
I used: sed -i 's/\\f$\s*\\R/\\f$ \\mathbb{R}/g'
2013-07-10 17:07:43 +02:00
Sébastien Loriot
e3bdde7054
remove explicit reference to a header file
2013-06-17 09:52:08 +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
Andreas Fabri
aaabcb362c
backquote
2013-03-13 21:44:22 +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
7d2903e230
add classified reference manual pages
2013-03-12 14:51:52 +01:00
Sébastien Loriot
16d225c727
do not refer to a file that is not present in doxygen doc layout
2013-02-01 17:13:02 +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
571f782910
remove extra .
2013-01-02 15:44:57 +01:00
Andreas Fabri
08502e7b08
polish Alpha_shape_3
2012-12-27 19:14: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
Andreas Fabri
7b50462e08
Remove documentation of class deprecated in 3.6
2012-11-23 15:06:15 +01:00
Andreas Fabri
6109a42358
Fix Fixed_alpha_shape
2012-11-23 14:59:23 +01:00
Andreas Fabri
19040345e2
Polish 3D Alpha Shapes
2012-11-23 13:25:58 +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
28161c23eb
using \section and \subsection uniformly
2012-11-05 22:24:44 +00:00
Sébastien Loriot
d163ad1ce3
new macros for multipule images and special cases
...
use a new div class for figure caption with a new css rule
update alpha-shape-3 and apolonnius user manual to use them
2012-11-01 08:54:08 +00:00
Sébastien Loriot
f1683f8abc
automatic numbering of figures using new doxygen macros + conceptify.py
...
update Alpha_shapes_3 packages to use that
2012-10-31 15:30:58 +00:00
Andreas Fabri
59877a8d52
linking and unlinking
2012-10-30 13:40:03 +00:00
Philipp Möller
31a3c07418
Turn \refines :: into \refines `X` globally
2012-10-25 09:48:39 +00:00
Philipp Möller
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +00:00
Philipp Möller
81c8c662d6
Fix some PkgDependsOn to stay inside the package overview, fix an
...
off-by-one in hacks.js, add a missing dependency
2012-10-18 16:31:12 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +00:00
Sébastien Loriot
928d867ea6
check and update Alpha_shape_3 documentation
2012-10-02 22:30:43 +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
9d96057636
Add PkgDependsOn to the package summary
2012-09-27 11:13:37 +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
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
Philipp Möller
1b3a78a08f
Salvage the demo information from the old package description.
2012-09-20 13:30:49 +00:00
Andreas Fabri
6f61e2b2ee
Downsize headings
2012-09-17 14:53:05 +00:00
Andreas Fabri
b7af4a58fd
math/de-math
2012-09-11 20:29:08 +00:00
Philipp Möller
2d8931167f
autoexamples
2012-08-29 16:20:55 +00:00
Philipp Möller
5a0a5403c4
Enable autotoc on mainpages
2012-08-29 15:45:17 +00:00
Philipp Möller
e2616dafb1
Rebuild the how_to_cite structure
2012-08-28 17:33:45 +00:00
Laurent Rineau
a3547dd7c3
Typo: s/Vv/Vb/
2012-08-27 15:58:59 +00:00
Andreas Fabri
5ac9f8679b
introduce a variable A
2012-08-27 13:57:44 +00:00
Andreas Fabri
d14258c752
fix linking in \has Models by backquoting
2012-08-27 10:38:20 +00:00
Andreas Fabri
af87732f6a
Add \anchor of chapters
2012-08-21 10:18:58 +00:00
Andreas Fabri
111175ee20
No mathmode in \name; typos
2012-08-21 08:32:48 +00:00
Andreas Fabri
3dfd7031c2
Remove whitespace
2012-08-20 18:30:46 +00:00
Andreas Fabri
d409ffdd7f
Fix nesting of <center><b>; Capitalize headings
2012-08-20 18:06:50 +00:00
Philipp Möller
d3a9a641de
Refurb package descriptions with a label for the license.
2012-08-20 14:28:36 +00:00
Andreas Fabri
9bfce74c95
No \em in mathmode
2012-08-16 21:42:57 +00:00