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
Laurent Rineau
0033b19157
Fix a precondition (bad copy paste from `vertex_triple_index()`)
2013-06-25 17:05:47 +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
2d947dc1d6
new cgal doxygen debug macro to put the text inside a div
2013-05-28 13:24:24 +02:00
Sébastien Loriot
170c619a2d
fix places where the <div> added by cgalAdvanced conflicts with other html tags
2013-05-28 09:51:49 +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
8d602ed8c2
Merge branch 'triangulation_3-copy_tds-sloriot'
...
Approved by the release manager
Conflicts:
Alpha_shapes_3/test/Alpha_shapes_3/copy_tds.h
Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h
it introduces a more general copy_tds that allows to copy tds with different types of simplices.
2013-04-29 11:09:01 +02:00
Laurent Rineau
d09971b3c3
Update the picture of Triangulation_utils_3 (was unreadable)
2013-03-28 14:51:56 +01:00
Andreas Fabri
2f95d1584a
Add a missing ';'
2013-03-14 14:02:31 +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
e991fe72ad
really add last missing classified reference manual pages
2013-03-13 10:57:01 +01:00
Sébastien Loriot
13a72756b8
Move the Vertex and Cell concepts outside of the class and add typedefs
...
The typedefs Vertex and Cell was missing in the concept
TriangulationDataStructure_3
2013-01-24 12:22:12 +01:00
Sébastien Loriot
4104ad62df
fix broken reference to figure
2013-01-24 11:20:20 +01:00
Sébastien Loriot
c3b8cef1b8
using template alias declarations to document rebind classes in TDS3
2013-01-24 11:17:57 +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
5f3c8826d1
h2 is the first header in classified reference manuals
2013-01-07 09:00:48 +01:00
Sébastien Loriot
7e095c7a7a
Merge branch 'Documentation-flat-ref-manual-pmoeller'
2013-01-04 15:19:57 +01:00
Sébastien Loriot
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
Sébastien Loriot
c44c259361
classified ref man for TDS3
2013-01-04 10:55:32 +01:00
Sébastien Loriot
9631c3444c
name link to chapters
2013-01-02 23:00:56 +01:00
Andreas Fabri
610de5e0ea
polish TDS_2
2012-12-28 21:46:44 +01:00
Sébastien Loriot
c625218033
incorrect documented returned type
2012-12-19 10:23:38 +01:00
Sébastien Loriot
aeb1edeae8
Merge branch 'triangulation_3-copy_tds-sloriot-old' into triangulation_3-copy_tds-sloriot
2012-12-18 19:57:32 +01:00
Sébastien Loriot
6ca36dfcce
add documentation for copy_tds
2012-12-17 16:40:05 +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
4283174bb0
Add vertex_triple_index
2012-11-21 10:25:09 +01:00
Philipp Möller
2f1e33a211
Fix unclosed figure command
2012-11-19 14:45:39 +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
5ee1081f92
using cgal macros for all figures
2012-11-08 17:17:29 +00: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
Philipp Möller
e51849bd87
add some more nesting to triangulation
2012-10-19 09:00:01 +00:00
Andreas Fabri
71073be43a
cleanup
2012-10-13 19:57:27 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +00:00
Andreas Fabri
492ed4d969
improve \brief
2012-10-03 09:29:56 +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
0aa7cd1c3b
Global heading reduction. Rename some Parameter section to Template
...
Parameters. Fix dependencies.
2012-09-21 09:42:24 +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
f1ef0eee60
This \sigma was \large in the .tex
2012-09-03 10:19:59 +00:00
Andreas Fabri
823642ab00
fix typo
2012-09-03 10:09:37 +00:00
Laurent Rineau
085d89112a
Remove the trailing space. That creates a bug in pkglist_filter.sh
2012-09-03 09:51:46 +00:00