Commit Graph

319 Commits

Author SHA1 Message Date
Andreas Fabri e716f5fdff Remove the word 2014-10-23 11:34:28 +02:00
Andreas Fabri 9388e7edaf fix a typo 2014-10-22 11:51:32 +02:00
Jane Tournois 5af3dcecff fix more typos 2014-10-21 15:18:20 +02:00
Jane Tournois ec2cf099cf fix more typos 2014-10-21 14:36:40 +02:00
Jane Tournois 8c7e6d2640 fix documentation
typos, and "traits" should be "traits class"
2014-10-21 14:07:42 +02:00
Andreas Fabri a20f48b861 remove debug output 2014-09-02 14:34:31 +02:00
Andreas Fabri e2d8610f87 Mark the polyline simplification function advanced 2014-09-02 14:33:47 +02:00
Andreas Fabri 425b900c5a fix typos 2014-08-22 12:48:19 +02:00
Andreas Fabri ff81c1acf9 fix dependencies 2014-08-22 12:47:34 +02:00
Andreas Fabri 43b8390a70 Merge branch 'Triangulation_2-NewPolylineConstraint-GF-old' into Triangulation_2-NewPolylineConstraint-GF 2014-08-08 12:47:15 +02:00
Andreas Fabri 9243e1eb69 Unify APIs: Add insertion of a polyline 2014-07-16 15:30:14 +02:00
Sébastien Loriot 089503ad4c add missing parameter in doc 2014-06-17 16:22:54 +02:00
Andreas Fabri ff3ad888c3 Polyline_simplification uses Constrained_triangulation_plus_2 2014-05-21 20:27:17 +02:00
Andreas Fabri 44f3d9e9a9 polish the demo and document Constrained_triangulation_plus_2::insert_constraints 2014-05-21 17:20:50 +02:00
Andreas Fabri 6b129f3ad0 unify API 2014-05-20 17:39:56 +02:00
Andreas Fabri 999b9a861a introduce polylines as constraints in the user manual 2014-05-20 15:18:53 +02:00
Andreas Fabri 2ce37a3391 The Polyline_constraint_triangulation_2 is now a Constrained_triangulation_plus_2 2014-05-20 14:15:11 +02:00
Andreas Fabri f238bf3651 add new doc of CT_plus_2 2014-05-20 14:07:04 +02:00
Andreas Fabri 121c2615f9 remove old doc of CT_plus_2 2014-05-20 14:06:33 +02:00
Andreas Fabri 575b9081a7 make Constaint_id a struct so that we can write operator pair<Vertex_handle,Vertex_handle>() 2014-05-19 11:49:08 +02:00
Andreas Fabri de59c8487a improve links 2014-05-19 10:42:20 +02:00
Andreas Fabri 57e84a5f1e cleanup 2014-05-16 16:25:19 +02:00
Andreas Fabri 85b29aed5f treat merge conflicts 2014-05-15 16:09:24 +02:00
Sébastien Loriot 9114db9085 restore figure source files removed in 0fa2cacb
| commit 0fa2cacb60
  | Author: Sébastien Loriot <sebastien.loriot@cgal.org>
  | Date:   Tue Dec 3 17:27:02 2013 +0100
  |
  |     remove doc_tex documentation (including developer manual) and old manual tools
2014-02-10 14:54:23 +01:00
Laurent Rineau 41d2286b75 Doc bug-fix about the section 'Non const access'
The section 'Non const access' of the documentation of Triangulation_2
was including const methods. I move the const method in the section
'Access Functions'.
2014-01-14 14:12:03 +01:00
Laurent Rineau 2c2ec8d54c Doc bug-fix: wrong name for constructor
One of the constructors of Regular_triangulation_2 was still named 'rt'.
2014-01-14 14:10:57 +01:00
Sébastien Loriot 84d97f385d add insert_constraints functions to Constrained_Delaunay_triangulation_2 2013-12-02 22:48:38 +01:00
Laurent Rineau 38e5dc102d Remove execution permissions 2013-11-13 14:05:43 +01:00
Sébastien Loriot 14850a1703 add missing examples in doc 2013-11-12 10:44:06 +01:00
Sébastien Loriot 979306eb93 add a link to common demo dlls and update demo macro to avoid repeating Demo 2013-10-22 12:16:48 +02:00
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
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
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 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
Andreas Fabri 94567d8745 wip 2013-04-16 15:09:05 +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
Andreas Fabri f70e23ff75 improve doc 2013-04-04 09:46:16 +02:00
Andreas Fabri 5e08e87d3d Make the example more interesting.
Fix const correctness.
Fix the Subconstraint_iterator.
Improve the manual.
2013-04-03 15:28:46 +02:00
Andreas Fabri 530adb1b9e doxygen fixes 2013-04-02 11:15:04 +02:00
Andreas Fabri 8a45fcea5a Merge branch 'OLD' into Triangulation_2-NewPolylineConstraint-GF
Conflicts:
	Triangulation_2/doc/Triangulation_2/Triangulation_2.txt
2013-03-21 13:41:53 +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
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
Andreas Fabri 53200a4dfb explain example 2013-01-28 13:56:34 +01:00
Andreas Fabri f83ed94229 A first pass over the user manual 2013-01-22 17:53:43 +01:00
Andreas Fabri e23c0d32b2 Add doxygen version of Polyline_constrained_triangulation_2.h 2013-01-21 16:43:07 +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 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
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
Andreas Fabri c7dc4a8bcd Switch to \tparam 2012-11-21 14:04:46 +01:00
Andreas Fabri b14cfce8cd polish T2 2012-11-21 11:18:36 +01:00
Andreas Fabri 3914ad9042 fix linking 2012-11-21 10:01:47 +01:00
Andreas Fabri 733699d0ed Improve \brief descriptions of all methods 2012-11-20 22:39:57 +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 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
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Andreas Fabri 4486d2f912 \refines must be backquoted in order to be typeset as code 2012-10-24 19:36:25 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 03ea3409ca pretty much finished, but let package owner have another pass 2012-10-15 15:22:22 +00:00
Andreas Fabri 1f7df8213f pretty much finished, but let package owner have another pass 2012-10-15 15:03:02 +00:00
Andreas Fabri b8b7a5dad3 get rid of spurious XX 2012-10-03 17:02:54 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Andreas Fabri 16992d9713 change link for \ccDepends 2012-10-03 11:00:43 +00:00
Andreas Fabri df29524d6e polish 2012-10-03 07:42:25 +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 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 128c228b4a Remove some glitches in Arrangement_2.
Exclude some symbols to end up with a nicer index.
2012-09-21 14:56:17 +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
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller 864aebe2e5 Merge next.
This commit also updates the respective mock-headers when the
corresponding .tex documentation has changed. This has been the case for:

AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABB_traits.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_features.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_no_features.tex
Number_types/doc_tex/NumberTypeSupport_ref/Interval_nt.tex
Number_types/doc_tex/NumberTypeSupport_ref/Lazy_exact_nt.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_2.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_3.tex
Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex
2012-09-12 14:14:22 +00:00
Philipp Möller 2d8931167f autoexamples 2012-08-29 16:20:55 +00:00
Philipp Möller 5a0a5403c4 Enable autotoc on mainpages 2012-08-29 15:45:17 +00:00
Andreas Fabri 416ffceb9a Subgroup so that the reference manual page becomes better structured 2012-08-29 14:56:48 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 9415b2b1c2 fix of class name 2012-08-27 12:11:51 +00:00
Andreas Fabri fe8dba062d fix linking in \hasModel by backquoting 2012-08-27 12:09:11 +00:00
Andreas Fabri df377c5631 fix linking in \hasModel by backquoting 2012-08-27 12:08:15 +00:00
Andreas Fabri 74d761fe19 fix linking in \has Models by backquoting and prefixing with CGAL namespace 2012-08-27 09:09:57 +00:00
Philipp Möller 76aacb1add Change created package names to be the pretty printed version instead
of the readable, short, easy-to-remember SVN version.
2012-08-23 17:00:30 +00:00
Andreas Fabri b6ed6e766f combine images; wording, whitespace 2012-08-23 09:49:10 +00:00
Andreas Fabri d34b0143e0 combine two images in one so that we can use \image 2012-08-23 09:42:20 +00:00
Andreas Fabri 36636cc264 typos 2012-08-22 19:46:43 +00:00
Philipp Möller b85624f7fb Add Triangulation_2 2012-08-22 16:14:22 +00:00