Sébastien Loriot
2f9408f867
rename link name to match package name
2018-10-08 10:28:55 +02:00
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
Philipp Möller
0a04a3a48f
Use CGAL_DOC_VERSION
2016-02-11 15:37:54 +01:00
Sébastien Loriot
72863bfe44
fix doxygen warnings
2016-02-04 21:19:36 +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
b28b4607ae
use UTF8 for letters with accent
2015-01-31 13:58:08 +01:00
Laurent Rineau
55f8095430
Fix a typo in a link of the doc
...
1/ Use explicit linking instead of implicit one.
2/ Fix the typo: AK_d_1::AlgebraicReal_1 -> AK_d_1::Algebraic_real_1
2014-01-03 11:49:30 +01:00
Luis Peñaranda
8d62e0d56f
minor doc fix in Algebraic_kernel_d reference
2013-11-19 20:41:27 -02:00
Laurent Rineau
38e5dc102d
Remove execution permissions
2013-11-13 14:05:43 +01:00
Michael Hemmer
11c8477dec
fixed doxygen issue
2013-08-21 16:09:14 +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
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
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
7e15467c72
new cgal doxygen advanced macro to put the text inside a div
2013-05-27 19:36:33 +02: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
716d6f03de
fix linking error and a typo in nested type name
2013-01-31 18:19:26 +01:00
Sébastien Loriot
91745e7ccf
fix linking
2013-01-07 20:43:56 +01:00
Sébastien Loriot
95d48245e1
add classified ref man for Algebraic Kernel
2013-01-07 14:45:28 +01:00
Philipp Möller
6e595d4e7c
Missing namespaces for linking to Algebraic_kernel
2012-12-21 14:14:04 +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
c2564ca24e
improve illustration
2012-12-02 22:42:19 +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
0f69c2a512
remove cpp0x namespace from documentation pages
2012-11-14 16:16:15 +01:00
Sébastien Loriot
8d741d504d
remove % in section name
2012-11-14 16:10:15 +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
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
36b8516419
Missing examples
2012-10-09 16:46:42 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +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
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
0aa7cd1c3b
Global heading reduction. Rename some Parameter section to Template
...
Parameters. Fix dependencies.
2012-09-21 09:42:24 +00:00
Andreas Fabri
accee5c864
unlink,link, autotoc
2012-09-21 07:23:45 +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
6783a9410b
Added Algebraic_kernel_d doc.
2012-09-18 10:32:13 +00:00