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
bc03aaf30b
Put doc/ in the global dont_submit file
2013-08-20 10:57:03 +02:00
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
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
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
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
716f87d2d7
rename Hidden_type to unspecified_type and update its description
2013-06-13 18:48:58 +02:00
fd0a2b46f4
Merge branch 'Documentation-remove-dxyassist-pmoeller'
2013-06-03 20:37:20 +02:00
fa177d6db5
fix typo
2013-05-31 12:03:56 +02:00
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
d4e379ba82
Small fixes in the generated Doxyfile.in
2013-05-30 15:32:33 +02:00
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
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
73a5428422
Replace Point_d<R> with R::Point_d.
2013-05-27 15:12:01 +02:00
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
e907f9f444
improve Kernel_23, Kernel_d, STL_extension and Arrangemnt doxygen doc
2013-05-23 10:57:36 +02:00
12e8f44d0f
fix doc-tex doc
2013-05-22 08:35:50 +02:00
47a4fe5273
prettify table
2013-04-16 09:45:07 +02:00
76e7e9a209
fix documented return type of intersection() for dD linear kernel
2013-04-16 09:43:40 +02:00
9877a32848
backtick'ing function arguments
2013-04-16 09:40:30 +02:00
c46a064653
better document intersection() return types for the dD linear kernel
2013-04-16 09:35:13 +02:00
bff03dd71d
fix compilation loop issue for decltype based result_of
2013-03-15 19:06:23 +01:00
fc6ce90c8c
prettify table
2013-03-14 14:49:03 +01:00
fa1f25d9f7
clean up Kernel_d nested concepts
2013-03-14 14:17:19 +01:00
f97d6b8bd9
s/boost::result_of/cpp11::result_of/g
2013-03-14 10:38:13 +01:00
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
c692bba14d
Minor fixes to documentation
2013-03-13 12:18:25 +01:00
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
890b02ead6
add last missing classified reference manual
2013-03-12 18:46:37 +01:00
39c705ec4d
fix anchor typo
2013-03-06 12:38:24 +01:00
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
615a2c5c07
remove doxygen link warnings in Kernel_d
2013-01-24 19:26:22 +01:00
5ec28b1cf4
replacing the usage of section in user man by \cgalHeading macro call
2013-01-07 18:04:37 +01:00
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
e38a5fb357
Clear up some wording and add helpful \sa links
2012-12-11 13:32:21 +01:00
513b07d0e7
Remove See Also clutter and move functions to the right files
2012-12-11 12:01:17 +01:00
12d1a88b47
Remove superfluous See Also groups
2012-12-11 10:49:43 +01:00
4685e2f440
Use result_of for intersections in Kernel_d
2012-12-10 17:56:01 +01:00
7b940e25a8
doc_tex -> doxygen of the Kernel_d documentation
2012-12-06 12:39:09 +01:00
d198458ca7
Merge branch 'origin-gsoc2011-boost_object-pmoeller' into Kernel-replace_object-pmoeller
...
Conflicts:
.gitattributes
AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABB_traits.tex
AABB_tree/include/CGAL/AABB_traits.h
AABB_tree/include/CGAL/AABB_tree.h
AABB_tree/test/AABB_tree/AABB_test_util.h
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2/arr_queries.tex
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/Arr_trapezoid_ric_point_location.tex
Arrangement_on_surface_2/doc_tex/Arrangement_on_surface_2_ref/intro.tex
Arrangement_on_surface_2/include/CGAL/Arr_batched_point_location.h
Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_generator_base.h
Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_random_generator.h
Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_trapezoid_ric_pl_impl.h
Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_walk_along_line_pl_impl.h
Arrangement_on_surface_2/include/CGAL/Arr_trapezoid_ric_point_location.h
Arrangement_on_surface_2/test/Arrangement_on_surface_2/point_location.cpp
Circular_kernel_2/include/CGAL/Circular_kernel_2/internal_functions_on_line_arc_2.h
Circular_kernel_3/include/CGAL/Circular_kernel_3/internal_functions_on_circular_arc_3.h
Circular_kernel_3/include/CGAL/Circular_kernel_3/internal_functions_on_line_arc_3.h
Circular_kernel_3/include/CGAL/Circular_kernel_3/internal_functions_on_sphere_3.h
Filtered_kernel/include/CGAL/Lazy.h
Filtered_kernel/include/CGAL/Lazy_kernel.h
Intersections_2/include/CGAL/Triangle_2_Iso_rectangle_2_intersection.h
Intersections_2/test/Intersections_2/test_intersections_2.cpp
Intersections_3/test/Intersections_3/test_intersections_3.cpp
Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
Kernel_23/include/CGAL/Kernel/Type_mapper.h
Kernel_d/doc_tex/Kernel_d_ref/Kernel.tex
2012-12-04 17:57:53 +01:00
9576be3c3b
add doc in dont_submit
2012-11-27 08:42:02 +01:00
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
6cc7d66415
Revert "Replace tex-style quotes with quotes that you would expect, as there"
...
This reverts commit e65a8028ea
2012-11-23 18:08:13 +01:00
7cd0e93fa9
Revert "Merge the changes to ccPrecond and ccPostcond that have been in"
...
This reverts commit b529971917
2012-11-23 18:04:33 +01:00
61fa49b242
Revert "break apart multi-cites, TO BE UNMERGED"
...
This reverts commit 5688d58b1b
2012-11-23 18:01:10 +01:00
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
e1ee35a04a
fix subsection name for concepts
2012-11-20 16:40:13 +01:00
625f9f6cd7
after git merge remotes/origin/hot-fixes-for-Git
2012-11-20 13:02:17 +01:00
8d741d504d
remove % in section name
2012-11-14 16:10:15 +01:00
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
Laurent Rineau
Philipp Möller
Ross Hemsley
Marc Glisse
Alexandros Konstantinakis-Karmis
Andreas Fabri