Commit Graph

736 Commits

Author SHA1 Message Date
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
Laurent Rineau bc03aaf30b Put doc/ in the global dont_submit file 2013-08-20 10:57:03 +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
Marc Glisse 14d2073dd2 Move Dimension.h back to its place. 2013-07-22 15:44:50 +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 0a460a947b remove deprecation warning 2013-06-26 07:27:59 +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
Monique Teillaud 6c4357eb2f doc bug fix (following a question by a user on cgal-discuss)
same as 2d8f2caf54
2013-06-03 09:06:08 +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 57325710ac remove extra typename and remove weird boost implementation detail in example 2013-05-23 14:44:47 +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 7baa997ce1 Merge branch 'Filtered_kernel-ring-glisse'
This branch adds an additional way to filter predicates that are only doing
operations using a ring number type. In case of failure, a RT is used rather
than an FT which speeds things up.

Successfully tested in CGAL-4.3Ic-37
2013-05-23 11:15:32 +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 12e8f44d0f fix doc-tex doc 2013-05-22 08:35:50 +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
Andreas Fabri f7d7395864 Merge branch 'OLD' into CGAL-use_leda-GF
Conflicts:
	Boolean_set_operations_2/test/Boolean_set_operations_2/test_polygon_validation.cpp
	Envelope_2/test/Envelope_2/test_envelope_segments.cpp
	Intersections_3/test/Intersections_3/bbox_other_do_intersect_test.cpp
2013-03-27 20:22:54 +01:00
Laurent Rineau b6ffa7c425 Merge branch 'CGAL-fix_warnings-GF'
That branch was successfully tested in CGAL-4.2-Ic-205.
2013-03-27 12:23:31 +01:00
Andreas Fabri 4d2f9280e8 Write an eol 2013-03-22 15:00:04 +01:00
Sébastien Loriot a50888d25d replace the recommanded boost way to have variadic variant by a macro
This is usually not something I like but the type generated by
the recommanded approach is an internal obfuscated type while
the macro produces a variant<A, B, C> type
2013-03-22 11:36:26 +01:00
Sébastien Loriot 9fcf46e11a replace CGAL_[kernel/qpe/triangulation/]_assertion by assert in tests
this should be the case, following our guidelines.

using:
find */test/* -name '*.[hc]*' | xargs sed -i 's/CGAL_assertion/assert/g'
2013-03-21 10:50:55 +01:00
Andreas Fabri 18dc806094 qualify compare with CGAL:: to avoid Koenig lookup 2013-03-19 08:31:32 +01:00
Sébastien Loriot 91943b0df1 remove result_type from Intersect_2 to avoid having it defined in derived class
also fix the compilation loop in Intersect_2::operator()
2013-03-15 19:00:00 +01:00
Andreas Fabri fc6fed9ee1 Add the use of LEDA as exact type in case we do not use GMP 2013-03-15 14:46:20 +01:00
Sébastien Loriot 14429d2b8e fix compilation errors 2013-03-14 18:32:14 +01: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
Andreas Fabri 4fffac9c1b remove unused variable name 2013-02-26 07:28:29 +01:00
Andreas Fabri 7db10a19e6 Add a CGAL_USE 2013-02-26 07:24:42 +01:00
Laurent Rineau 2d8da664a3 Merge branch 'CGAL-fix_warnings-gdamiand'
Conflicts:
	.gitignore
	Skin_surface_3/examples/Skin_surface_3/CMakeLists.txt
2013-02-22 13:02:37 +01:00
Laurent Rineau 26a7e70785 New license.txt files (eol changes)
The new version 2.13.0 of licensecheck has changed the spaces at eol.
2013-02-19 16:46:39 +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 f0f34d45fa workaround to force the usage of the tr1 implementation of result_of from boost
see http://www.boost.org/doc/libs/1_52_0/libs/utility/utility.htm#result_of
2013-02-04 11:30:28 +01:00
Andreas Fabri 13bac84716 less warnings in various packages 2013-02-01 10:27:07 +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
Andreas Fabri c59152f478 simplification 2013-01-31 15:09:20 +01:00
Andreas Fabri 72bbb807be less warnings in the Kernel testsuite 2013-01-31 15:06:04 +01:00
Andreas Fabri 65b74a8437 Add a file that tests nested types required by the Kernel comcept (for now RT) 2013-01-31 14:47:03 +01:00
Andreas Fabri ea299439a8 deal with Kernel examples 2013-01-31 14:27:31 +01:00
Sébastien Loriot 6a0ab7f089 remove linking warnings
those types cannot be linked to something
2013-01-31 06:53:54 +01:00
Marc Glisse 5373cff1b3 Split some predicates into CGAL_Kernel_pred_RT. 2013-01-14 14:19:51 +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
Marc Glisse 571f370e28 Rename Exact_type_selector to Exact_field_selector. 2012-12-24 12:20:13 +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
Philipp Möller 0f34f2a89e Merge branch 'Maintenance-include-less-boost-pmoeller' 2012-12-21 09:44:18 +01:00
Sébastien Loriot e446188097 add constructor from bbox for iso-cuboid and iso-rectangle 2012-12-20 10:41:23 +01:00
Sébastien Loriot 82b2ebc865 apply the cpp0x namespace renaming in all files 2012-12-19 11:33:17 +01:00
Philipp Möller c5f3c7b4f4 Use angle-bracket includes 2012-12-14 18:19:57 +01:00
Philipp Möller 71ea8e6e22 Minimal boost includes
Replace type_traits.hpp and utility.hpp with the respective
fine-grained includes.
2012-12-14 18:13:59 +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 ef855a59a0 Add the deprecation version 2012-12-11 10:41:50 +01:00
Philipp Möller 7cfc88ca90 Use the same wording for all deprecation notices. 2012-12-11 10:41:35 +01:00
Philipp Möller cbd2b2b946 Missing copyright notice 2012-12-11 10:33:46 +01:00
Philipp Möller 396e0f9262 Pretty indent for readability 2012-12-10 15:53:48 +01:00
Andreas Fabri ece2fa38d4 examples no longer use Object 2012-12-06 17:55:38 +01:00
Philipp Möller a214d62bd6 Integrate boost::variant with Lazy kernels interaction
This requires changing the way Lazy_construction_XXX wrappers are
selected and some code to unpack variants.
2012-12-06 17:27:23 +01:00
Philipp Möller 8415eb6484 Upgrade type mapper to handle variantS and optionalS
Add the necessary specializations of Type_mapper_impl to do deep
inspection of boost::variant and boost::optional.
2012-12-06 17:27:23 +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