Commit Graph

278 Commits

Author SHA1 Message Date
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
Philipp Möller 18ea1db34a more nesting for compare_y 2012-08-24 09:54:11 +00:00
Philipp Möller c2d826dcb8 * Internal class Null_vector and Origin
* more groups for Affine Transformation
2012-08-24 09:50:22 +00:00
Andreas Fabri b561e9003a simplification of table; unlink 2012-08-24 09:24:58 +00:00
Philipp Möller d872758355 missing end of namespace 2012-08-24 09:05:06 +00:00
Philipp Möller edf9658734 fix broken group name 2012-08-23 18:09:14 +00:00
Philipp Möller 36824b5311 prevent link 2012-08-23 18:08:50 +00:00
Andreas Fabri cc6f47193f move from one group to another 2012-08-23 15:48:45 +00:00
Andreas Fabri b3765761d6 create kernel group 2012-08-23 15:42:28 +00:00
Andreas Fabri 63b88fbbdf create 2D and 3D class groups 2012-08-23 15:21:40 +00:00
Andreas Fabri fceba2b8b7 unlink, un<I> 2012-08-23 14:59:19 +00:00
Philipp Möller 34b71f7920 Layout juggling, configuration refinement 2012-08-23 14:00:05 +00:00
Philipp Möller 56c1938a52 Add Kernel_23 2012-08-23 12:16:14 +00:00