Commit Graph

158 Commits

Author SHA1 Message Date
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
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