Commit Graph

174 Commits

Author SHA1 Message Date
Marc Glisse 0d33f5dd9c Remove the old tentative to document preKernel.
Remove the local patched copies of Handle_for and Lazy, they are
necessary for ref-counting and for Lazy_d, but not for Epick_d.
2014-06-20 15:08:36 +02:00
Marc Glisse cb4ca9d8c8 Don't use Dynamic_dimension_tag::value. 2014-05-07 19:28:33 +02:00
Marc Glisse 5c85856e14 Remove trailing whitespace. 2014-05-07 19:01:26 +02:00
Marc Glisse cf26434f0c Improve hyperplane support. 2014-04-19 13:04:18 +02:00
Marc Glisse 602d4e059a Ambient_dimension. 2014-03-19 15:07:19 +01:00
Marc Glisse 3168c851a1 Merge branch 'Kernel_d-rewrite-glisse-old' into Kernel_d-rewrite-glisse
Conflicts:
	Kernel_d/doc_tex/Kernel_d/kernel_representation_d.tex
	Kernel_d/doc_tex/Kernel_d_ref/Homogeneous_d.tex
	Kernel_d/doc_tex/Kernel_d_ref/Kernel.tex
	Kernel_d/doc_tex/Kernel_d_ref/main.tex

Resolved by dropping those files.
2014-03-12 12:38:08 +01:00
Marc Glisse b9af149293 Remove \cgalModif markers. 2014-02-02 12:52:44 +01:00
Sébastien Loriot cc30859ea1 fix typedef
doc bugfix
2014-01-30 08:36:36 +01:00
Marc Glisse 066bbb2da2 Minor doc updates. 2013-11-25 16:27:32 +01:00
Guillaume Damiand 4df9e9fe7d Add ; in doc and newline after cgalModifEnd macro. 2013-11-25 13:24:58 +01:00
Marc Glisse 050ce22ecb Remove out-of-date content after KernelWithLifting_d introduction. 2013-11-24 11:31:16 +01:00
Marc Glisse 8ddf8255d5 Merge branch 'Kernel_d-rewrite-glisse-old' into Kernel_d-rewrite-glisse
Hopefully the doc will be easier to build this way.
2013-11-23 12:34:18 +01:00
Marc Glisse e600819820 Split the lifting and projection predicates into a refinement of Kernel_d. 2013-11-23 12:25:33 +01:00
Marc Glisse 569aa80b0a Say a few more words about Dynamic_dimension_tag, document a few more functions for Point_d.
Doc may not compile (didn't check).
2013-11-22 01:27:13 +01:00
Marc Glisse 5d6c4c207b Explain DimensionTag in the user manual. 2013-11-18 19:35:11 +01:00
Marc Glisse 8aa03c152c Rename parameter of Epick_d to DimensionTag. 2013-11-18 18:18:01 +01:00
Marc Glisse 9165a9f965 Use consistent notations. 2013-11-18 18:09:33 +01: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 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
Marc Glisse 2a7b549d5e A few more updates to the user manual for Epick_d. 2013-07-26 18:10:10 +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
Marc Glisse 4d6d5e685b Reviewers asked that Epick_d take a type argument for the dimension
instead of an int.
2013-07-21 15:31:57 +02:00
Marc Glisse dafdb45786 Move is_iterator changes back to the original file. 2013-07-19 21:55:34 +02:00
Marc Glisse 95c6e3526d More doc that only applies to Cartesian_d and Homogeneous_d. 2013-07-19 20:16:23 +02:00
Marc Glisse 71c9e2b427 Follow some reviewer comments. Untested (the more I rebuild the doc, the
longer it takes...).
2013-07-19 19:50:55 +02:00
Marc Glisse 4c4318ee6b Minor fixes. doxygen complains a lot (for the whole cgal) and outputs
duplicated functions for Point_d, but the information is there.
2013-07-19 19:22:54 +02:00
Marc Glisse a5b9e12a7c Copy the doc to doxygen (haven't tried to compile yet). 2013-07-19 18:57:33 +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 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 fa177d6db5 fix typo 2013-05-31 12:03:56 +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
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Marc Glisse 994e7e16fb Kernel_d::LA is not part of the concept and is already mentioned in
Cartesian_d and Homogeneous_d.
2013-05-27 16:37:24 +02:00
Marc Glisse 73a5428422 Replace Point_d<R> with R::Point_d. 2013-05-27 15:12:01 +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 47a4fe5273 prettify table 2013-04-16 09:45:07 +02:00
Sébastien Loriot 76e7e9a209 fix documented return type of intersection() for dD linear kernel 2013-04-16 09:43:40 +02:00
Sébastien Loriot 9877a32848 backtick'ing function arguments 2013-04-16 09:40:30 +02:00
Sébastien Loriot c46a064653 better document intersection() return types for the dD linear kernel 2013-04-16 09:35:13 +02:00
Sébastien Loriot fc6ce90c8c prettify table 2013-03-14 14:49:03 +01:00
Sébastien Loriot fa1f25d9f7 clean up Kernel_d nested concepts 2013-03-14 14:17:19 +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
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 890b02ead6 add last missing classified reference manual 2013-03-12 18:46:37 +01:00
Sébastien Loriot 39c705ec4d fix anchor typo 2013-03-06 12:38:24 +01:00
Sébastien Loriot 615a2c5c07 remove doxygen link warnings in Kernel_d 2013-01-24 19:26:22 +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
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 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 12d1a88b47 Remove superfluous See Also groups 2012-12-11 10:49:43 +01:00
Andreas Fabri 7b940e25a8 doc_tex -> doxygen of the Kernel_d documentation 2012-12-06 12:39: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
Sébastien Loriot e1ee35a04a fix subsection name for concepts 2012-11-20 16:40:13 +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 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Philipp Möller bdf6f2e47d Small fixes for some awkward back-ticks and correctly link in Polygon. 2012-10-03 13:19:39 +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 b64ba48134 The changes to move the package overview labels into the
PackageDescription.
2012-09-25 17:17:49 +00:00
Andreas Fabri 730f1b5682 unlink 2012-09-25 13:32:09 +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
Andreas Fabri cd9262859b (un)linking 2012-09-21 08:12:58 +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 edc8892f74 Add Kernel_d doc. 2012-09-18 12:14:41 +00:00