Commit Graph

127 Commits

Author SHA1 Message Date
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 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +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 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot 33fcbe043a typo in doc 2013-05-08 14:30:26 +02:00
Sébastien Loriot 7d2903e230 add classified reference manual pages 2013-03-12 14:51:52 +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
Laurent Rineau e06a6f535b Add or fix license/copyright headers in CGAL headers 2013-02-19 16:45:00 +01:00
Laurent Rineau d19578725b Fix warnings 2013-02-07 18:15:23 +01:00
Andreas Fabri b9dbe90bd3 remove, don't comment 2013-01-30 20:32:16 +01:00
Sébastien Loriot d05a8a15f3 make STL concepts doxygen concepts and update script to change thein icons
local links class are of class el while external links are of class elRef.
This was needed for CGAL.CGAL/html/annotated.html
Note that the patch on html_output_postprocessing.py also make conceptify run
in CGAL.CGAL (for STL concepts)
2013-01-24 06:10:59 +01:00
Guillaume Damiand 0ec26e6752 Remove warning in circulator test 2013-01-23 15:41:42 +01:00
Sébastien Loriot 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +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
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 7cd0e93fa9 Revert "Merge the changes to ccPrecond and ccPostcond that have been in"
This reverts commit b529971917.

Conflicts:
	Approximate_min_ellipsoid_d/doc_tex/Bounding_volumes_ref/Approximate_min_ellipsoid_d.tex
	Matrix_search/doc_tex/Polytope_distance_d_ref/spec_all_furthest_neighbors.tex
	Min_annulus_d/doc_tex/Bounding_volumes_ref/Min_annulus_d.tex
	Min_circle_2/doc_tex/Bounding_volumes_ref/Min_circle_2.tex
	Min_ellipse_2/doc_tex/Bounding_volumes_ref/Min_ellipse_2.tex
	Min_quadrilateral_2/doc_tex/Bounding_volumes_ref/spec_oops.tex
	Min_sphere_d/doc_tex/Bounding_volumes_ref/Min_sphere_d.tex
	Min_sphere_of_spheres_d/doc_tex/Bounding_volumes_ref/MinSphereOfSpheresTraits.tex
	Min_sphere_of_spheres_d/doc_tex/Bounding_volumes_ref/Min_sphere_of_spheres_d.tex
	Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Taucs_matrix.tex
	Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Taucs_symmetric_matrix.tex
	Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_triangulation_2.tex
	Width_3/doc_tex/Polytope_distance_d_ref/Width_3.tex
2012-11-23 18:04:33 +01:00
Andreas Fabri ee003db1c2 Reorganize introducion of Circulators 2012-11-22 12:56:06 +01:00
Philipp Möller 8e1bc0a0f5 Shut up warnings about missing return types 2012-11-20 09:47:24 +01:00
Philipp Möller 801721202e Extend the concept to operator-> and fix the bug in edge_circulator.
The work-around is a little fishy, because it involves storing the
segment, but so it be. The concept shouldn't check for operator->
though, it is too strict.
2012-11-17 02:32:44 +01:00
Philipp Möller 465c5b265a Shuffle two undocumented headers backwards.
Also change the 2 places they were used in.
2012-11-17 02:16:32 +01:00
Philipp Möller e623040728 Refactor circulators a little
Give a name proper name to meta-functions that are not used outside
Circulator and enable conversion between circulator tags.
2012-11-17 02:05:19 +01:00
Philipp Möller f15cf44e06 Change to proper include style 2012-11-17 01:57:23 +01:00
Philipp Möller e2502e5b16 Add circulator concepts and a (not useful) test-case. 2012-11-16 22:05:10 +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
Andreas Fabri 7736798599 linking unlinking 2012-10-30 13:09:46 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 3066cf41c7 finished 2012-10-08 10:43:41 +00:00
Andreas Fabri b8b7a5dad3 get rid of spurious XX 2012-10-03 17:02:54 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +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
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
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Andreas Fabri 11d83f019d fix /</I> 2012-09-13 14:19:15 +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 eeee9063e0 i.e.\ ; linking 2012-09-04 09:46: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 e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 1db03e28cf typo 2012-08-27 20:12:59 +00:00
Philipp Möller d3a9a641de Refurb package descriptions with a label for the license. 2012-08-20 14:28:36 +00:00
Philipp Möller ad5cbb472b Circulators 2012-08-17 16:14:22 +00:00
Laurent Rineau 90414d195f Move <CGAL/Testsuite/use.h> to <CGAL/use.h> (in the Installation package)
That is a followup to the following commit:
  | ------------------------------------------------------------------------
  | r71090 | pmoeller | 2012-08-07 13:04:32 +0200 (Tue, 07 Aug 2012) | 6 lines
  | Changed paths:
  |    M /branches/next/Alpha_shapes_2/include/CGAL/Alpha_shape_2.h
  |    M /branches/next/Circulator/include/CGAL/circulator.h
  |    M /branches/next/Convex_decomposition_3/include/CGAL/Convex_decomposition_3/Reflex_vertex_searcher.h
  |    M /branches/next/Intersections_3/test/Intersections_3/bbox_other_do_intersect_test.cpp
  |    M /branches/next/Kernel_d/include/CGAL/Cartesian_d.h
  |    M /branches/next/Mesh_3/include/CGAL/IO/File_medit.h
  |    M /branches/next/Mesh_3/include/CGAL/Mesh_cell_criteria_3.h
  |    M /branches/next/Mesh_3/include/CGAL/Mesh_edge_criteria_3.h
  |    M /branches/next/Mesh_3/include/CGAL/Mesh_facet_criteria_3.h
  |    M /branches/next/Mesh_3/include/CGAL/make_mesh_3.h
  |    M /branches/next/Nef_2/include/CGAL/Bounded_kernel.h
  |    M /branches/next/Nef_2/include/CGAL/Nef_polyhedron_2.h
  |    M /branches/next/Nef_3/include/CGAL/Nef_3/ID_support_handler.h
  |    M /branches/next/Nef_3/include/CGAL/Nef_3/Infimaximal_box.h
  |    M /branches/next/Nef_3/include/CGAL/Nef_3/vertex_cycle_to_nef_3.h
  |    M /branches/next/Nef_3/include/CGAL/Nef_polyhedron_3.h
  |    M /branches/next/Nef_3/test/Nef_3/nef_union_error_llvm.cpp
  |    M /branches/next/Nef_S2/include/CGAL/Nef_S2/SM_overlayer.h
  |    M /branches/next/OpenNL/include/CGAL/OpenNL/blas.h
  |    M /branches/next/Periodic_3_triangulation_3/include/CGAL/Periodic_3_triangulation_3.h
  |    M /branches/next/Point_set_processing_3/include/CGAL/mst_orient_normals.h
  |    M /branches/next/QP_solver/include/CGAL/QP_solver/QP_functions_impl.h
  |    M /branches/next/STL_Extension/include/CGAL/iterator.h
  |    M /branches/next/Segment_Delaunay_graph_2/include/CGAL/Segment_Delaunay_graph_simple_site_2.h
  |    M /branches/next/Subdivision_method_3/include/CGAL/Polyhedron_decorator_3.h
  |    M /branches/next/Subdivision_method_3/include/CGAL/Subdivision_mask_3.h
  |    M /branches/next/Surface_mesher/include/CGAL/Surface_mesh_default_criteria_3.h
  |    M /branches/next/Voronoi_diagram_2/include/CGAL/Voronoi_diagram_2/Adaptation_traits_functors.h
  |    M /branches/next/Voronoi_diagram_2/include/CGAL/Voronoi_diagram_2/Default_site_inserters.h
  |    M /branches/next/Voronoi_diagram_2/include/CGAL/Voronoi_diagram_2/Default_site_removers.h
  | 
  | WARNFIX: Silence a good part of unused variable/parameter warnings.
  | 
  | Wextra results in a dreadful wall of yellow in the test-suite and is
  | scary when using CGAL. Reduce some of the noise by silencing the
  | obvious cases with CGAL_USE or comments.
  | 
  | ------------------------------------------------------------------------

The reason is that everything from CGAL/Testsuite/ is removed in public
releases (that was discussed at a CGAL developers meetings, long ago). That
means that r71090 introduced compilation errors undetectable by the tests
of internal releases. I hope that the minutes of that developers meeting
say that I was against the removal of headers between internal and public
releases!  -- Laurent Rineau
2012-08-09 15:34:08 +00:00