Commit Graph

462 Commits

Author SHA1 Message Date
Mael Rouxel-Labbé 11786a7b90 Fixed minor mistakes from a rebase 2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 108830ec3e Reworded warning about implicit and explicit conversions of Points/Weighted_points 2017-06-28 10:15:30 +02:00
Mael Rouxel-Labbé e95d3d3f2b Make all conversions between Point and Weighted_point explicit
Also doc changes
2017-06-28 10:14:35 +02:00
Andreas Fabri ce8a0be55e Update manual for Angle_3 and angle() 2017-05-12 09:49:41 +02:00
Andreas Fabri 2a05190ebc Fix in the manual 2017-05-12 09:49:41 +02:00
Andreas Fabri a53cd10919 typo 2017-05-12 09:49:40 +02:00
Andreas Fabri 9ccc9c1178 Fix compare_slope() 2017-05-12 09:49:39 +02:00
Andreas Fabri 5f8bc52082 Add angle(Point_3, Point_3,Point_3,Vector_3) 2017-05-12 09:48:23 +02:00
Andreas Fabri 061a9b1ecd Kernel:23 Add Compare_slope_3 2017-05-12 09:48:21 +02:00
Laurent Rineau cbd73f4274 Merge pull request #2046 from MaelRL/Kernel-Fix_weighted_point-GF
Improve the implementation of weighted_point_23
2017-05-09 12:14:23 +02:00
Mael Rouxel-Labbé 8915b4472d Minor documentation fixes 2017-04-21 13:13:20 +02:00
Mael Rouxel-Labbé c79e2d4b36 Added Compute_power_product_2 to the 2D kernel predicates
doc + test included
2017-04-21 13:07:40 +02:00
Mael Rouxel-Labbé bb086ff739 Added power_side_of_bounded_power_circle_2 to the 2D kernel predicates
A partial implementation was deleted from the Alpha_shapes_2 package without
moving the functions to the kernel...
This implementation adds the missing overloads (4, 3, and 2 points)

Test + doc included
2017-04-21 11:37:27 +02:00
Mael Rouxel-Labbé a751464ab6 Minor fixes to weighted functors (doc + cleaning) 2017-04-21 11:31:13 +02:00
Mael Rouxel-Labbé 232c38cee1 Removed documentation of degenerate cases of power_side_of_oriented_* predicates
See Issue https://github.com/CGAL/cgal/issues/2067
2017-04-20 12:54:39 +02:00
Mael Rouxel-Labbé cf45a408c1 Fixed doc of CoplanarOrientation_3 2017-04-19 15:15:26 +02:00
Mael Rouxel-Labbé dd2e7f3a0c Made compute_squared_smallest_orthogonal_circle_2() a kernel functor
and documented, tested, etc. it

Previously in Alpha_shape_2
2017-04-19 11:06:14 +02:00
Mael Rouxel-Labbé e65eae4802 Removed unnecessary comma 2017-04-19 09:03:04 +02:00
Mael Rouxel-Labbé de7fb095ac Fixed doc of power_side_of_bounded_power_sphere 2017-04-18 21:51:27 +02:00
Mael Rouxel-Labbé 64768b3b37 Fixed missing weight references 2017-04-18 21:46:05 +02:00
Mael Rouxel-Labbé b01078c887 Removed "starting with 0" from coordinate accessor 2017-04-18 15:30:20 +02:00
Christian Gagneraud d8502c0469 Fix a few typos in the documentation 2017-04-16 13:20:12 +12:00
Mael Rouxel-Labbé 23f2df44be Cleaned trailing whitespace in Point_23/Weighted_point_23 2017-04-13 12:01:08 +02:00
Mael Rouxel-Labbé 7d16ce69ec Removed mentions of explicit conversions between Weighted points and Points
This is for another branch!
2017-04-11 15:49:29 +02:00
Mael Rouxel-Labbé cc4f17c9e7 Minor doc fixes 2017-04-10 18:48:37 +02:00
Mael Rouxel-Labbé 05835d2c2a Fixed power tests and clarified the documentation 2017-04-10 12:52:39 +02:00
Mael Rouxel-Labbé ef17853876 Minor documenation fixes 2017-04-07 03:46:05 +02:00
Mael Rouxel-Labbé 14dd33eb43 Fixed ConstrustRadicalAxis_2 not showing up in doc 2017-04-06 21:28:20 +02:00
Mael Rouxel-Labbé ca408108a2 Added documentation of Construct_weighted_point_23 2017-04-06 12:46:29 +02:00
Mael Rouxel-Labbé 0d42994d1e Fixed incomplete Weighted_point_23 documentation 2017-04-06 12:39:43 +02:00
Andreas Fabri 1a3a6e93ee Kernel_23: fix typesetting in the manual.
Leading whitespace has semantics, so we remove it
2017-03-22 17:13:28 +01:00
Laurent Rineau aee5e80d74 Fix typos in the doc 2016-12-30 16:44:08 +01:00
Laurent Rineau 5457a85b6b Merge pull request #1656 from afabri/Kernel-Linfinity_distance-GF
Kernel_23: Add the function  FT  l_infinity_distance() for 2D and 3D points
2016-12-28 16:12:31 +01:00
Sébastien Loriot cad6cbbcf4 fix doc issues detected by recent doxygen
duplicated labels, missing bibtex entry and nested comments
2016-12-28 13:59:45 +01:00
Sébastien Loriot 5937892cc8 fix intersection links 2016-12-28 11:19:37 +01:00
Maxime Gimeno b0dd7d25cb Add Compute_L_infinity_distance_3. 2016-12-21 09:41:33 +01:00
Andreas Fabri eb7e38493c Add the function FT l_infinity_distance(Point_2, Point_2)
as well as the corresponding functor

This is a function where the implementation is in the file
Kernel_23/include/CGAL/Kernel/function_objects.h

When the implementation is different for Cartesia and Homogeneous coordinates
the code should go into the function_objects.h files
in the packages Cartesian_kernel and Homogeneous_kernel
2016-12-21 09:40:53 +01:00
Jane Tournois e12697d2c7 improve doc 2016-11-24 16:59:01 +01:00
Jane Tournois 3d99cc6e96 fix typo 2016-11-03 14:55:39 +01:00
Jane Tournois 306323d45c make doc and doc consistent
- add "model of Concept" as much as possible in the modified classes/concepts
- fix some links
- update package description of Kernel_23
2016-11-03 14:55:39 +01:00
Jane Tournois de13b047dd remove from doc functor that does not exist anymore 2016-11-03 14:53:54 +01:00
Andreas Fabri ec96a19052 fix links 2016-11-03 14:53:54 +01:00
Andreas Fabri 07e9997980 Add \sa 2016-11-03 14:53:54 +01:00
Jane Tournois 446004444e fix 2 typos 2016-11-03 14:53:54 +01:00
Jane Tournois c770b29928 fix typo 2016-11-03 14:53:54 +01:00
Jane Tournois 15f71af4ac add missing class 2016-11-03 14:53:54 +01:00
Jane Tournois cbf31a09f5 add missing concepts 2016-11-03 14:53:54 +01:00
Jane Tournois 358119f590 reorder things 2016-11-03 14:53:54 +01:00
Jane Tournois db37ec56c2 add documentation of concept PowerSideOfBoundedPowerSphere_3 2016-11-03 14:53:54 +01:00
Andreas Fabri 1ad7bfa202 Add Compute_weight_2/3 concepts and models to the doc 2016-11-03 14:53:54 +01:00
Andreas Fabri a8b9c92a68 Add signature of operators; todo: Add comment 2016-11-03 14:53:54 +01:00
Andreas Fabri dbb2cc3598 Sign -> Bounded_side; typo in code 2016-11-03 14:53:54 +01:00
Andreas Fabri 24b5993037 fix \sa links 2016-11-03 14:53:54 +01:00
Andreas Fabri ad9d2c369c Rename tests following Olivier's recommendations 2016-11-03 14:53:54 +01:00
Andreas Fabri d78735364b Fixes after review by Monique and Olivier 2016-11-03 14:53:15 +01:00
Andreas Fabri f488b9baf9 Changes after Laurent's review 2016-11-03 14:53:15 +01:00
Andreas Fabri e39f76b953 Add doc to concept Kernel 2016-11-03 14:07:26 +01:00
Andreas Fabri 6793ce53da typo 2016-11-03 14:07:26 +01:00
Andreas Fabri aa8b100a13 3 -> 2 2016-11-03 14:07:26 +01:00
Andreas Fabri 8e6264344a improve doc 2016-11-03 14:07:26 +01:00
Andreas Fabri a80e9ce7e0 polish 2016-11-03 14:07:26 +01:00
Andreas Fabri dcf5f32dc0 Improve the doc 2016-11-03 13:07:50 +01:00
Andreas Fabri 881837ba2d start fixing doc 2016-11-03 13:07:50 +01:00
Andreas Fabri 9dde08c414 WIP 2016-11-03 13:07:50 +01:00
Andreas Fabri 34eb29cac5 Documentation 2016-11-03 13:07:17 +01:00
Andreas Fabri af6c2e185e remove Compute_point_3 2016-11-03 13:06:02 +01:00
Sébastien Loriot 125d190ebd disambiguate p and P 2016-10-28 14:00:15 +02:00
Laurent Rineau c6cf01c7f6 Merge pull request #1562 from afabri/Kernel_Compute_dihedral_angle-GF
Add doc of functor class and concept corresponding to dihedral_angle()
2016-10-20 09:48:05 +02:00
Laurent Rineau 3e0ab881c1 Merge pull request #1584 from afabri/Installation-compute_dependencies-GF
Make Algebraic_kernel_d independent from CGAL/Arr_enum.h
2016-10-20 09:47:42 +02:00
Andreas Fabri 554bd0fd26 Make Algebraic_kernel_d independent from CGAL/Arr_enum.h
Introduce Box_parameterization_2 in CGAL/enum.h
Add a typedef and constants in the Arrangement package to stay bw compatible
2016-10-17 11:56:43 +02:00
Laurent Rineau f2e7050364 Merge pull request #1428 from sloriot/AABB_tree-fix_Closest_point
Fix implementation of AABB_traits::Closest_point
2016-10-17 10:03:20 +02:00
Laurent Rineau 8dda7b3cd1 Merge pull request #1362 from sloriot/Kernel_23-add_compound_assignement_operator_for_vectors
Add compound assignment operators for 2D and 3D vector classes
2016-10-17 10:00:53 +02:00
Andreas Fabri 423242be31 dihedral_angle() -> approximate_dihedral_angle() 2016-10-11 15:35:20 +02:00
Andreas Fabri aebcc9534a s -> d And fill in the dots 2016-10-10 15:36:15 +02:00
Andreas Fabri d76f120e41 Add doc of functor class and concept corresponding to dihedral_angle; Also replace ... 2016-10-10 15:07:38 +02:00
Laurent Rineau 223c1cf5a4 Merge pull request #1530 from lrineau/Installation-compute_dependencies-GF
Compute and fix packages dependencies
2016-10-05 13:11:04 +02:00
Sébastien Loriot c0bed6e759 replace \sa by \cgalHasModel and \cgalModels 2016-10-03 08:50:41 +02:00
Andreas Fabri c58582b5ec Add global function dihedral_angle() 2016-09-30 15:23:15 +02:00
Sébastien Loriot c751ab4310 Add operators for segment and triangle types in Construct_projected_point_3
the original implementation comes from the AABB-tree package
2016-09-01 16:04:55 +02:00
Sébastien Loriot 6c447e37f2 add compound assignement operator for points 2016-08-25 10:45:10 +02:00
Sébastien Loriot 151d52bb84 add compound assignment operators for 2D and 3D vector classes 2016-08-24 15:16:18 +02:00
Sébastien Loriot e2ed53ec63 fix backtick issue 2016-08-22 14:43:30 +02:00
Andreas Fabri 3f22b1e049 Add doc of free function for 2D 2016-07-07 14:56:20 +02:00
Andreas Fabri 5c1a2bd835 Add global function scalar_product(Vector_2,Vector_2) 2016-07-07 14:42:57 +02:00
Andreas Fabri 6273a0a247 Add global function scalar_product(Vector_3,Vector_3) 2016-07-07 14:30:10 +02:00
Andreas Fabri 79b0257e59 Merge branch 'Cone_spanners_2-new_package-UWS-old' into Cone_spanners_2-new_package-UWS 2016-04-26 09:01:56 +02:00
Andreas Fabri 2443b7d1a6 Moved squared_distance(Point_3,Triangle_3 2016-03-30 16:58:22 +02:00
Sébastien Loriot 103687fbc7 move documentation file 2016-03-04 14:13:30 +01:00
Sébastien Loriot 5c5f59ba58 fix doc typo 2016-02-18 16:59:31 +01:00
Andreas Fabri 9b830970f0 default constructed Bbox_{2,3} is now initialized empty [+inf,-inf]^dim 2016-02-16 17:04:47 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Sébastien Loriot e64ae35a6e Merge pull request #542 from bo0ts/Documentation-release_build2-pmoeller
Allow to build the documentation in a release
2016-01-07 09:21:46 +01:00
Andreas Fabri 206420c77b backquote 2016-01-06 08:22:27 +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 0ad467b321 Use generic example directories 2015-12-10 17:05:53 +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
Carsten Brandt 5c0b043e4c Fixed code example for Upgrading intersection
The variable names in the example do not make sense, hope my changes are correct.
2015-12-05 04:25:15 +01:00
Andreas Fabri 760e4d1b4e prefix cpp11::result_of with CGAL:: 2015-10-13 15:06:50 +02:00
Sébastien Loriot 93e1a78a40 document missing do_intersect overloads for Iso_cuboid_3 2015-10-06 08:16:38 +02:00
Sebastien Loriot e58486a077 Merge pull request #351 from afabri/Intersections_3-snippet2example-GF
Convert <code> sections into cgalExamples
2015-10-01 14:41:12 +02:00
Andreas Fabri eb8d2f5752 fixed three documentation typos 2015-09-22 09:26:10 +02:00
Andreas Fabri e27d5632ce typo 2015-09-18 14:24:17 +02:00
Andreas Fabri a2f954ebf9 Merge branch 'Intersections_3-snippet2example-GF-old' into Intersections_3-snippet2example-GF 2015-09-18 12:56:29 +02:00
Michael Hemmer a754942869 update see also 2015-03-26 14:18:33 +01:00
Michael Hemmer 0cdc653281 add typedef for:
Exact_predicates_exact_constructions_kernel_with_kth_root
Exact_predicates_exact_constructions_kernel_with_root_of

add documentation
add testing
2015-03-26 13:46:23 +01:00
Sébastien Loriot 5dc1b3e30d move functions out of the wrong group 2015-02-20 07:54:48 +01:00
Andreas Fabri 1f989622e7 replace \code with real examples 2015-02-09 10:54:24 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Andreas Fabri f97bd9fb33 fixed typo 2015-01-19 09:07:11 +01:00
Andreas Fabri 9b4a1f219f no \cite in \brief as doxygen stops the brief description right before the \cite 2015-01-14 09:15:26 +01:00
Andreas Fabri babaa99826 Merge branch 'CGAL-Getting_Started-GF'
Approved by the release manager
Conflicts:
	Documentation/doc/Documentation/main.txt
2015-01-12 11:29:26 +01:00
Andreas Fabri 73d4fe8fee Add % 2014-11-28 18:17:07 +01:00
Andreas Fabri 4be974b230 Improve Getting Started 2014-10-14 18:38:18 +02:00
Sébastien Loriot 0e46afa617 Merge branch 'Convex_hull_3-traits_class_fixes-sloriot'
Fixes bugs in the 3D convex hull traits concept, in particular due to the
  handling of coplanar points

  Tested in CGAL-4.5-Ic-72
  Approved by the release manager

Conflicts:
	Installation/changes.html
2014-06-18 09:41:53 +02:00
Sébastien Loriot 4ed2497f2e add missing possible return value 2014-06-10 22:37:27 +02:00
Laurent Rineau 2463459ce6 Doc for the two overloads of Angle_3::operator() 2014-05-21 12:19:13 +02:00
Laurent Rineau 73f4734525 Fix permissions 2014-05-15 18:33:36 +02:00
Efi Fogel 016c40fdbc Fixed typos in documentation---minor fix for master 2014-03-31 23:52:31 +03:00
Efi Fogel 8f80982272 Fixed typos in documentation---minor fix for master 2014-03-31 23:51:23 +03: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
Sébastien Loriot cc30859ea1 fix typedef
doc bugfix
2014-01-30 08:36:36 +01:00
Andreas Fabri a020773bbc fix #include in the manual 2014-01-17 12:42:52 +01:00
Laurent Rineau afd4cfbfef Fix a typo
Equal_2 is not related to Point_3.
2014-01-08 16:10:58 +01:00
Sébastien Loriot b3de157a24 linking bug in documentation 2013-12-18 17:45:51 +01:00
Jane Tournois fa530983dd documentation bug fix 2013-12-06 09:54:21 +01:00
Laurent Rineau 0ea21c36ab Add more "See Also": refer to the general BoundedSide_[23] functor 2013-09-04 14:04:55 +02:00
Laurent Rineau 61393efa4f Add some "See Also" to HasOn((B|Unb)oundedSide|Boundary)_[23] 2013-09-04 14:02:32 +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 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 08c9214275 doc: last replacements of \R by \mathbb{R} 2013-07-11 07:29: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 cd5e88f11f Merge branch 'Kernel_23-Bbox_more_friendly-local'
Implements Features/Small_Features/More_friendly_bbox
Successfully tested in CGAL-4.3-Ic-74
Approved by the release manager
2013-06-28 15:05:31 +02:00
Sébastien Loriot c09ec2beaa Merge branch 'Kernel-replace_object-pmoeller'
Successfully tested in CGAL-4.3-Ic-59
Approved by the release manager

Conflicts:
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
	Kernel_d/doc/Kernel_d/Kernel_d.txt
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-06-14 14:26:05 +02: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 fd0a2b46f4 Merge branch 'Documentation-remove-dxyassist-pmoeller' 2013-06-03 20:37:20 +02:00
Sébastien Loriot 5635183db7 add global functions bbox_2 and bbox_3 in the Kernel
remove the function from the 2D function from the Polygon package
2013-05-31 19:44:21 +02:00
Sébastien Loriot 43d4a00db0 add operator+= in bbox classes 2013-05-31 19:09:31 +02:00
Marc Glisse 2bb3b27454 Merge branch 'Kernel_d-doc-glisse' 2013-05-30 22:14:12 +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
Ross Hemsley c0690f87f4 Manually inserted tags that could not be generated automatically
added in options that were in XML but were not moved across to new Doxyfile.in files.
2013-05-30 14:45:18 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Monique Teillaud 2d8f2caf54 doc bug fix (following a question by a user on cgal-discuss) 2013-05-28 16:50:54 +02:00
Marc Glisse 2b26ecc42b Replace Point_2<R> with R::Point_2. 2013-05-27 15:30:06 +02:00
Sébastien Loriot c67ba90514 Merge branch 'Kernel-replace_object-pmoeller-old' into Kernel-replace_object-pmoeller
Conflicts:
	Circular_kernel_2/include/CGAL/Circular_kernel_2/Circular_arc_2.h
	Circular_kernel_2/include/CGAL/Circular_kernel_2/internal_functions_on_circle_2.h
	Installation/changes.html
	Kernel_d/doc/Kernel_d/CGAL/intersections_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h
	Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h
2013-05-23 13:13:08 +02:00
Sébastien Loriot e907f9f444 improve Kernel_23, Kernel_d, STL_extension and Arrangemnt doxygen doc 2013-05-23 10:57:36 +02:00
Sébastien Loriot 7055eb1961 better document intersection() return types for the 2/3 linear kernel 2013-04-16 09:34:31 +02:00
Sébastien Loriot cbbecfbc83 fix intersection/do_intersect groups and links 2013-04-16 09:17:27 +02:00
Sébastien Loriot fff0776446 Merge branch 'Kernel_23-Iso_rectangle_2_Iso_cuboid_3_bbox_constructible'
Conflicts:
	Kernel_23/include/CGAL/Iso_cuboid_3.h

Tested in CGAL-4.3-Ic-1
2013-04-16 07:50:38 +02:00
Sébastien Loriot f97d6b8bd9 s/boost::result_of/cpp11::result_of/g 2013-03-14 10:38:13 +01:00
Sébastien Loriot d6905c61be Merge branch 'Kernel-replace_object-pmoeller-old' into Kernel-replace_object-pmoeller
Conflicts:
	AABB_tree/include/CGAL/AABB_tree.h
	Circular_kernel_2/include/CGAL/Circular_kernel_2/internal_functions_on_line_arc_2.h
	Intersections_3/include/CGAL/Intersections_3/intersection_3_1_impl.h
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-03-14 10:29:31 +01:00
Alexandros Konstantinakis-Karmis c692bba14d Minor fixes to documentation 2013-03-13 12:18:25 +01:00
Sébastien Loriot 890b02ead6 add last missing classified reference manual 2013-03-12 18:46:37 +01:00
Sébastien Loriot bdd68c5f5f fix Kernel concept documentation
some requirements from the Kernel were missing.
Also add some missing concepts in Kernel namespace
The rationale is geometric objects such as CGAL::Point_3
have member functions, and these member functions are
implemented using functor objects required by the Kernel concept.
2013-02-14 12:32:45 +01:00
Sébastien Loriot b9a26cada3 add missing space 2013-02-14 10:31:19 +01:00
Sébastien Loriot b3988de4d5 add naming convention and dimension to the sections
this has been forgotten during the migration
2013-01-31 21:17:51 +01:00
Sébastien Loriot 6a0ab7f089 remove linking warnings
those types cannot be linked to something
2013-01-31 06:53:54 +01:00
Sébastien Loriot 1952cc37ed linking to global function kernel groups 2013-01-09 19:48:43 +01:00
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Sébastien Loriot c5a76c7334 fix linking to global function groups in Kernel 2013-01-09 19:48:40 +01:00
Sébastien Loriot 6fa9502ecd Origin and Null_vector are not internal 2013-01-09 19:48:40 +01:00
Sébastien Loriot 7ecf2981af rename kernel global function groups 2013-01-09 19:48:39 +01:00
Sébastien Loriot 1debeb5cde defining intersection and do_intersection subgroups in one place 2013-01-09 19:48:39 +01:00
Sébastien Loriot af3a5c20df rename kernel global function groups 2013-01-09 07:38:26 +01:00
Sébastien Loriot cec8cf406d add missing group for compare_signed_distance_to_plane 2013-01-09 07:03:17 +01:00
Sébastien Loriot 8ce1ad94b5 prettify link to intersection function 2013-01-08 17:50:31 +01:00
Sébastien Loriot fd028691b7 fix linking of centroid and barycenter in Kernel 2013-01-08 17:50:30 +01:00
Sébastien Loriot 0aaa77de4a fix linking to intersection and do_intersect overloads 2013-01-08 17:50:29 +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
Philipp Möller a85b2a2ed8 Document the fact that there are default arguments 2012-12-21 11:52:22 +01:00
Philipp Möller 4c280edf83 Remove it from the Kernel 2012-12-21 11:52:07 +01:00
Sébastien Loriot e446188097 add constructor from bbox for iso-cuboid and iso-rectangle 2012-12-20 10:41:23 +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
Philipp Möller 39ae0f987a Cleaning the documentation
Less and better See Also, a special page for upgrading
2012-12-11 14:41:46 +01:00
Philipp Möller 2fbdec4d81 Prevent doxygen warnings about explicit link requests to type 2012-12-11 13:35:40 +01:00
Philipp Möller e38a5fb357 Clear up some wording and add helpful \sa links 2012-12-11 13:32:21 +01:00
Philipp Möller 513b07d0e7 Remove See Also clutter and move functions to the right files 2012-12-11 12:01:17 +01:00
Philipp Möller 7cfc88ca90 Use the same wording for all deprecation notices. 2012-12-11 10:41:35 +01:00
Andreas Fabri ece2fa38d4 examples no longer use Object 2012-12-06 17:55:38 +01:00
Andreas Fabri 7b940e25a8 doc_tex -> doxygen of the Kernel_d documentation 2012-12-06 12:39:09 +01:00
Andreas Fabri 9dd07fad37 doc_tex -> doxygen of the STL Extension documentation 2012-12-05 17:15:25 +01:00
Sébastien Loriot 920eb63882 backporting documentation changes of master@9fcc5b57 into doxy-port-pmoeller
Conflicts:
	Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h
	Installation/doc_tex/Installation/usage.tex
	Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h
	Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h
	Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h
2012-11-23 22:54:31 +01:00
Sébastien Loriot 2c3d505bb6 backport commit in tex file from master into doxygen 2012-11-23 17:55:07 +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 4c0c9857db fix linking/unlinking 2012-11-20 10:56:39 +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
Philipp Möller 634d9f0c37 Mark the Kernel namespace with cgalconceptnamespace 2012-10-30 17:56:08 +00:00
Philipp Möller f7ead73360 Those concepts got removed in the last revision of the kernel doc but
their new files fell through.
2012-10-30 13:19:33 +00:00
Philipp Möller c22dcc53a5 Sort and split stuff to be easier to handle and have a nicer lists. 2012-10-25 12:07:35 +00:00
Philipp Möller aa7de02ba0 Forgot to replace ingroup with addtogroup. 2012-10-25 10:29:15 +00:00
Philipp Möller c4ae57f661 Turn of SORT_GROUP_NAMES for the Kernel and give the appropriate hints
to sort the function groups.
2012-10-25 10:17:06 +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 c48ef2954c Small fixes 2012-10-17 08:36:09 +00:00
Sébastien Loriot 26acfe9998 remove last warnings by introducing Ambient_dimension and Feature_dimension in Kernel concept 2012-10-12 11:05:59 +00:00
Sébastien Loriot d749e70140 explicit link for nested type in template classes. 2012-10-12 09:41:36 +00:00
Sébastien Loriot 0354260992 Kernel is done 2012-10-11 23:16:54 +00:00
Sébastien Loriot 9c1d00b013 de-math 2012-10-11 23:10:18 +00:00
Sébastien Loriot ef52b587d7 remove extra `` around . 2012-10-11 22:44:34 +00:00
Sébastien Loriot c4e40f96c3 de-math:
perl -p -i -e 's/\\f\$\s([a-w])\\f\$/`$1`/g' *.h
2012-10-11 22:38:48 +00:00
Sébastien Loriot 4905c23e75 avoid brief 2012-10-11 22:35:05 +00:00
Sébastien Loriot 0a5d74f24f more kernel fixes 2012-10-11 21:19:51 +00:00
Sébastien Loriot ebf4235889 remove exe property 2012-10-11 21:03:39 +00:00
Sébastien Loriot a90f4e483d global functions should be OK now 2012-10-11 21:02:34 +00:00
Sébastien Loriot 27d6ab21bd adding CGAL namespace to enable linking
Iso_box_2 -> Iso_rectangle_2
2012-10-11 20:34:25 +00:00
Sébastien Loriot 0f858a4361 demath 2012-10-11 16:52:12 +00:00
Sébastien Loriot f032722098 enum linking for global functions 2012-10-11 16:38:25 +00:00
Sébastien Loriot 4ff9e2ce42 working on Kernel doc 2012-10-11 16:37:05 +00:00
Sébastien Loriot 348ed0e094 referencing enum 2012-10-11 15:43:42 +00:00
Sébastien Loriot 3bca323c92 typos 2012-10-11 15:28:53 +00:00
Sébastien Loriot c78856d07a fix on kernel objects 2012-10-11 15:01:30 +00:00
Sébastien Loriot ad84258c3e fix do_intersect and mimick the decomposition
of intersection
2012-10-11 13:44:39 +00:00
Sébastien Loriot 0467116303 clean up intersection global function 2012-10-11 13:08:47 +00:00
Sébastien Loriot 58db3e0dc8 de-math 2012-10-10 21:51:57 +00:00
Sébastien Loriot ba47180395 prettify kernel concept functor declaration (identical to Spherical Kernel) 2012-10-10 20:58:20 +00:00
Sébastien Loriot 037af203ee missing CGAL:: 2012-10-10 17:15:26 +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 fec5566306 i.e. / de-math 2012-10-02 21:11:55 +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 a2f6aa1d5e Minor grouping fixes, linebreaks. 2012-10-02 09:51:54 +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 299716d7c9 Small grouping fixes in the kernel. 2012-09-28 17:01:24 +00:00
Andreas Fabri 227a8bfdd8 Add missing projection traits pages 2012-09-26 11:41:11 +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 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 aba82f6027 i.e. need \ in \brief 2012-09-11 12:30:42 +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
Philipp Möller 87bfa5ebbb Move the lost example to the right place 2012-08-29 15:31:43 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 3b1a496f13 Unlink 'Default' 2012-08-28 14:05:21 +00:00
Andreas Fabri 7e1d93d60e Add template <typename Kernel> to all global functions; was already wrong in the old documentation 2012-08-28 13:12:05 +00:00
Andreas Fabri 65edc2aa94 fix linking in \hasModel by backquoting 2012-08-27 13:54:42 +00:00
Andreas Fabri fd1c486d8d fix linking in \hasModel by backquoting 2012-08-27 13:28:13 +00:00
Andreas Fabri c9bf9faeeb Add \details and unify headings for subgoups dispatching into kernels 2012-08-24 14:45:50 +00:00
Andreas Fabri 0424e982fe unlink; 2d -> 2D 2012-08-24 14:00:15 +00:00
Andreas Fabri 85f9f048e3 T const& -> const T& 2012-08-24 13:50:24 +00:00
Andreas Fabri 4549a21732 subgroup for the different kernels 2012-08-24 13:30:34 +00:00