Commit Graph

65 Commits

Author SHA1 Message Date
Laurent Rineau 3ad8f223cd Fix the documentation of the Tds parameters of cell base classes
And add see also between Compact_mesh_cell_base_3 and Mesh_cell_base_3.
2013-10-16 16:34:41 +02:00
Sébastien Loriot 197b9210ee add missing advanced 2013-08-08 20:02:07 +02:00
Sébastien Loriot 9c2f35ed1a using cgalHeading instead of h3 2013-08-07 10:06:49 +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 6d9aeba4f2 add missing links 2013-08-05 09:48:45 +02:00
Sébastien Loriot e1465ce617 add missing template parameter
requested by Monique
2013-08-05 09:18:41 +02:00
Sébastien Loriot da4fccda97 remove doc of hierarchy vertices and triangulation, deprecated since 3.6 2013-08-05 09:12:07 +02:00
Sébastien Loriot f2219bfa46 update classifed ref man 2013-08-05 09:03:23 +02:00
Sébastien Loriot b2ef3b8673 Merge branch 'doc-remove_gif-local'
Successfully test in CGAL-4.3-Ic-102

This commit fixes a few issues in the doxygen documentation and in particular
the figure for the generation of latex doc.

Approved by the interim release manager

xplain why this merge is necessary,
2013-07-26 17:50:07 +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 143a2181b3 add latex format for \imagei doxygen command
perl -pe 's/^(\s*)\\image\s+html\s+(.*)\s*$/$1\\image html $2\n$1\\image latex $2\n/' -i
2013-07-25 11:50:53 +02:00
Sébastien Loriot 74a1ac055e remove pdf files from doxygen doc include path 2013-07-25 11:15:18 +02:00
Sébastien Loriot 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +02:00
Sébastien Loriot 4389b0bac8 remove the usage of gif in the doxygen doc as pdflatex does handle them
replace the files with png
2013-07-25 11:06:13 +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