Commit Graph

101 Commits

Author SHA1 Message Date
Sébastien Loriot e8975dbac7 function documentation fixes
remove the repetition of the name of the function in its brief description
 add parenthesis for function matching "function\s+`[a-z0-9_]`"
2013-09-03 14:25:50 +02:00
Sébastien Loriot 9c2f35ed1a using cgalHeading instead of h3 2013-08-07 10:06:49 +02:00
Sébastien Loriot 07a13bb06a remove duplicated Inherits from sections and using cgalHeading instead of <h3> 2013-08-07 08:30:17 +02:00
Sébastien Loriot c78b190217 remove extra [ 2013-08-06 10:44:35 +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 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 b63bbc0d6d document Weighted_point_mapper_2
it explains to the user how a weighted point turns into a point

fix bug #15745
2013-07-25 17:51:56 +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
Jane Tournois dcf22e09bb improve documentation for inexact_locate (because 'inexact_locate' does not come after 'locate' in the output of long descriptions of functions) 2013-06-24 13:28:44 +02:00
Jane Tournois 404f2e0e3c merge 2013-06-21 10:01:19 +01:00
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Philipp Möller f118e7c6eb Clean up the files we use as examples 2013-05-31 11:40:35 +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
Jane Tournois f7e249e3d6 typo fix 2013-05-30 12:18:41 +02:00
Jane Tournois 6b63e0585c fix documentation of inexact_locate 2013-05-30 11:02:17 +02:00
Jane Tournois efec975bd8 add comment about what inexact_locate returns when triangulation is not in full dimension 2013-05-28 16:08:05 +02:00
Jane Tournois af93d9b5ad doc improvement suggested by Monique 2013-05-28 16:03:27 +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
Jane Tournois edf8dbccc7 fix documentation as asked by small feature 'inexact_locate' reviewers 2013-04-18 13:32:36 +02:00
Sébastien Loriot 62fcc226b8 add a method to insert a range of points with info in cdt 2013-04-16 07:37:51 +02:00
Sébastien Loriot 498492e770 add set_infinite_vertex to Triangulation_3 and use it with copy_tds
the 2D version already exists
2013-04-12 16:04:59 +02:00
Jane Tournois 4e89e2ddbf add inexact locate to documentation of T_2 2013-04-12 14:40:09 +02: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
Laurent Rineau 7ce5bd0a10 Fix a typo in the doxygen doc of Triangulation_2::is_edge
Fixed bug #15472:

https://gforge.inria.fr/tracker/?func=detail&atid=13845&aid=15472&group_id=52
2013-03-11 10:47:03 +01:00
Andreas Fabri 770256c3ef fix doc of enum 2013-03-07 14:30:41 +01:00
Sébastien Loriot d34b150e36 using cgalFigureRef instead of ref fig__ 2013-01-24 11:26:16 +01:00
Sébastien Loriot f2d0cc34cd add implementation note in template alias declaration 2013-01-24 11:24:40 +01:00
Sébastien Loriot 6f60be121b fix wrong figure ref 2013-01-24 08:56:09 +01:00
Sébastien Loriot 2444c08a86 move TDS_2::Vertex and TDS_2::Face concepts outside of the class
this allows to define the nested typedefs of the same name.
2013-01-24 08:51:57 +01:00
Sébastien Loriot d4f5f4569b using template alias declaration to inline the rebind classes 2013-01-24 08:37:55 +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 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
Andreas Fabri 073bc9794f polish TDS_2 2012-12-28 21:28:58 +01:00
Claudia Werner ef3648433f fix typo in user manual in constrained Delaunay Triangulations. 2012-12-21 11:16:56 +01:00
Sébastien Loriot 59f9e8a778 add constructor from range for 2D Delaunay and Regular triangulation 2012-12-19 17:10:57 +01:00
Sébastien Loriot d0f1090611 add documentation for tds2 copy_tds 2012-12-19 10:43:48 +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 eb41ac1765 typo 2012-11-22 09:54:22 +01:00
Andreas Fabri d8ab8d3181 typo 2012-11-21 14:10:08 +01:00