Sébastien Loriot
b28b4607ae
use UTF8 for letters with accent
2015-01-31 13:58:08 +01:00
Sébastien Loriot
0e22279452
add missing space
2014-12-04 15:50:13 +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
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
Alexandros Konstantinakis-Karmis
c692bba14d
Minor fixes to documentation
2013-03-13 12:18:25 +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
7e59c14580
add a header to classified reference pages using a doxygen macro
2013-03-12 14:33:49 +01:00
Sébastien Loriot
06e2aee35f
doc bugfix: missing nested type in CK2
2013-02-13 15:28:13 +01:00
Sébastien Loriot
7ecf2981af
rename kernel global function groups
2013-01-09 19:48:39 +01:00
Sébastien Loriot
5a641325e2
fix function references in CK2 and CK3
2013-01-08 17:50:32 +01:00
Sébastien Loriot
0aaa77de4a
fix linking to intersection and do_intersect overloads
2013-01-08 17:50:29 +01:00
Sébastien Loriot
112e4e45d8
fix function linking
2013-01-08 17:50:29 +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
df08193e00
using \link command instead of \ref command to have the tt font
2013-01-07 16:21:46 +01:00
Sébastien Loriot
66e2348742
avoid linking Kernel
2013-01-07 09:49:05 +01:00
Sébastien Loriot
5f3c8826d1
h2 is the first header in classified reference manuals
2013-01-07 09:00:48 +01:00
Sébastien Loriot
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
Sébastien Loriot
e9f018e3dd
classified ref man for Circular Kernel 2
2013-01-03 09:44: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
Andreas Fabri
151d636fa4
Add Line_2 to the CirularKernel concept
2012-11-20 12:30:07 +01:00
Andreas Fabri
bc7dad48f5
fix linking
2012-11-20 11:43:44 +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
Andreas Fabri
7a6634b5a7
No need for CGAL:: in user manuals
2012-10-31 20:11:16 +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
Sébastien Loriot
3980b3cc2d
prettify + fix group
2012-10-11 08:32:57 +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
Philipp Möller
1b3a78a08f
Salvage the demo information from the old package description.
2012-09-20 13:30:49 +00:00
Philipp Möller
4a80ebd27b
Add a todo for strange brief descriptions.
2012-09-18 10:04:30 +00:00
Andreas Fabri
be1aa762a9
smaller heading
2012-09-17 18:29:50 +00:00
Andreas Fabri
278b4443ee
linking, grouping
2012-09-17 18:22:04 +00:00
Philipp Möller
082de1fcd8
Add Circular_kernel_2 doc
2012-09-17 16:21:30 +00:00