Commit Graph

538 Commits

Author SHA1 Message Date
Philipp Möller e17201c286 Remove superfluous styling 2013-01-25 11:24:12 +01:00
Laurent Rineau 0ce7a00f1e Add comments in that test program (Emacs local variables)
That file uses wrong lenght for TAB characters. Those comments added Emacs
buffer local variables so that Emacs users can view and edit that files
nicely.

(Approved by the release manager... who is myself.)
2013-01-24 18:12:56 +01:00
Laurent Rineau 34327e9688 Merge remote-tracking branch 'origin/AABB_tree-fix_documentation-lrineau' 2013-01-22 17:22:41 +01:00
Laurent Rineau 65750effb1 Improve the documentation of the class template AABB_tree
- Group the documented methods that were not.
- Document typedefs that are used in the methods declarations.
- Use \tparam when relevant.
- Fix a comment block that was prefixed with '    ///' or '\t\t///'
  depending on the lines. That one is particularily nasty because the
  difference between lines is invisible. But that was confusing Doxygen.
- plus minor fixes
2013-01-16 15:04:17 +01:00
Laurent Rineau 54bacd752a Rename tests to lowercase names, for uniformity 2013-01-16 10:46:39 +01:00
Laurent Rineau 827a70e110 Fix crashes when the AABB tree contains only one primitive.
An extra test program has been added to test all functions of the API with
a singleton AABB tree.
2013-01-16 10:39:52 +01:00
Laurent Rineau fc3061c822 Bug fix: fix AABB_tree doc and code about preconditions !empty()
The AABB_tree code had several assertions checkinng that the tree was not
empty. Those preconditions were not documented. There was several places in
the code were it was not really required that the tree is not empty.

This patch rationalizes the preconditions: only the function `bbox()` and
the queries about distances or closest things now require that the tree is
not empty.
2013-01-15 17:19:11 +01:00
Sébastien Loriot 4b252e8cc2 add missing backticks 2013-01-08 17:50:28 +01:00
Sébastien Loriot 318c280932 less linking 2013-01-07 19:26:50 +01:00
Andreas Fabri d16be07906 polish AABB Tree 2012-12-27 20:36:04 +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
Sébastien Loriot 7d20531b1d Convert remaining CRLF files to LF 2012-12-04 17:09:28 +01:00
Philipp Möller 1adf441b18 Convert all CRLF files to LF 2012-12-03 18:44:24 +01:00
Sébastien Loriot 533b9f07b3 BUG: typedef has moved 2012-11-28 12:05:02 +01:00
Sébastien Loriot 4ec9529581 Merge branch 'doxy-port-pmoeller'
Conflicts:
	.gitattributes
	Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h
	Surface_reconstruction_points_3/include/CGAL/Reconstruction_triangulation_3.h
	Surface_reconstruction_points_3/include/CGAL/k_nearest_neighbor.h
2012-11-27 10:05:41 +01:00
Sébastien Loriot 9576be3c3b add doc in dont_submit 2012-11-27 08:42:02 +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 6cc7d66415 Revert "Replace tex-style quotes with quotes that you would expect, as there"
This reverts commit e65a8028ea.

Conflicts:
	Approximate_min_ellipsoid_d/doc_tex/Bounding_volumes_ref/Approximate_min_ellipsoid_d.tex
	Approximate_min_ellipsoid_d/documentation/mel.tex
	Documentation/doxyassist.xml
	Installation/doc_tex/Installation/usage.tex
	Min_sphere_of_spheres_d/doc_tex/Bounding_volumes_ref/MinSphereOfSpheresTraits.tex
	Optimisation_doc/doc_tex/Bounding_volumes/user_part.tex
	Optimisation_doc/doc_tex/Inscribed_areas/user_part.tex
	Width_3/doc_tex/Polytope_distance_d_ref/Width_3.tex
2012-11-23 18:08:13 +01:00
Andreas Fabri 625f9f6cd7 after git merge remotes/origin/hot-fixes-for-Git 2012-11-20 13:02:17 +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 974621b58f start using new figure macros.
For Combinatorial maps, I reintroduced the original anchor names as they
were still in use in the reference manual.
2012-11-08 10:55:09 +00:00
Philipp Möller 8f19c3d595 Remove size_type from TraversalTraits.
There is no reason for TraversalTraits to know the size_type (or any
of the other typedefs) and removing it prevents an unnecessary
instantiation of AABB_tree and a funky include.
2012-10-23 14:56:26 +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 a484b9ba7d remove todo 2012-10-10 21:00:18 +00:00
Sébastien Loriot fb244b47b4 remove empty destructor 2012-10-10 12:41:11 +00:00
Sébastien Loriot 9b44f4f7d8 AABB_tree is finished 2012-10-10 12:31:37 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +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
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 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Philipp Möller 50e5409ffe Merge next and restore the temporary delete of Bounding_volumes/doc 2012-09-20 11:37:03 +00:00
Philipp Möller 2987470868 Add Kinetic doc. 2012-09-19 14:01:12 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller d30771c4c2 Fix a typo in a tex command that broke the AABB_tree documentation. 2012-09-12 14:29:30 +00:00
Philipp Möller 864aebe2e5 Merge next.
This commit also updates the respective mock-headers when the
corresponding .tex documentation has changed. This has been the case for:

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
Mesh_3/doc_tex/Mesh_3_ref/parameters_features.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_no_features.tex
Number_types/doc_tex/NumberTypeSupport_ref/Interval_nt.tex
Number_types/doc_tex/NumberTypeSupport_ref/Lazy_exact_nt.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_2.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_3.tex
Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex
2012-09-12 14:14:22 +00:00
Andreas Fabri 1d120f7da4 polish 2012-09-12 08:04:13 +00:00
Andreas Fabri 632d2c7b76 template parameter AT got replaced by AABBTraits 2012-09-04 11:45:35 +00:00
Philipp Möller 0b80f4fa4c Removed double example inclusion. 2012-08-30 13:00:28 +00:00
Andreas Fabri 1c5bdb7882 take the thumb teaser 2012-08-30 12:42:08 +00:00
Andreas Fabri c1c932a1a0 various fixes 2012-08-30 10:29:46 +00:00
Philipp Möller 7ab9597e20 Correct name for the group 2012-08-30 10:21:16 +00:00
Philipp Möller e18df919df double table of contents 2012-08-30 09:39:53 +00:00
Andreas Fabri 79e8f20043 rename teaser.png 2012-08-30 09:37:10 +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 e2b79eb9db Manually move AABB_tree here 2012-08-29 15:27:03 +00:00
Sébastien Loriot 80140d1bba move function 2012-08-28 13:12:59 +00:00
Sébastien Loriot 6e00e85f3e remove documented but not implemented size_type (that should not be here anyway) 2012-08-28 13:11:28 +00:00