Commit Graph

445 Commits

Author SHA1 Message Date
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 a9cdb27b78 Remove tautological precondition 2012-12-12 11:28:57 +01:00
Philipp Möller fc1a811b90 Correct the documentation of default 2012-12-03 16:37:00 +01:00
Sébastien Loriot e1be9d2a14 missing include statement 2012-11-28 12:05:03 +01:00
Philipp Möller 93ccbf4465 Remove misleading sentence about array construction
Also improve the make_array documentation to be more concise and
honest.
2012-11-27 15:57:48 +01:00
Philipp Möller 7776eb1631 Pluralize group names. 2012-11-27 15:43:28 +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
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
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
Andreas Fabri 625f9f6cd7 after git merge remotes/origin/hot-fixes-for-Git 2012-11-20 13:02:17 +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 09e65b9c40 Drop the include guard and remove assert_equal_types
The include guard is unnecessary (tags.h is part of basic and no one
else defines it anymore) and it shouldn't be used anyway.

assert_equal_types doesn't do it's job completely and it's usage in
Nef_2 has been replaced.
2012-11-17 01:56:05 +01:00
Sébastien Loriot 0f69c2a512 remove cpp0x namespace from documentation pages 2012-11-14 16:16: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
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Laurent Rineau 17dc5f2db1 Typo 2012-10-30 17:30:07 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 88a2f0d2db Fix a few warnings 2012-10-09 17:09:25 +00:00
Andreas Fabri c600bd13a5 Add documentation of Join_input_iterator_3 2012-10-09 08:53:12 +00:00
Andreas Fabri 555f3cc729 Add documentation of Join_input_iterator_2 2012-10-09 07:15:43 +00:00
Andreas Fabri 8f7bb695b7 finished including a cleanup in Creators 2012-10-08 20:08:00 +00:00
Andreas Fabri 3b48c61b26 finished including a cleanup in Creators 2012-10-08 19:10:57 +00:00
Laurent Rineau 7bc300794d Fix last errors in headers of CGAL foundations
All were missing #include.
2012-10-08 09:03:50 +00:00
Philipp Möller 91f88474a8 The conditional code does not only require variadic templates but also
a variadic implementation of tuple. One would think that you never run
in a situation where you only have variadics but no tuple. But thanks
to clang pretending to be a gcc 4.2.1, some configuration code might
think otherwise.
2012-10-05 18:15:46 +00:00
Laurent Rineau 5c757a0a4d Fix/Improve all #include of all STL_Extension headers 2012-10-05 14:24:38 +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 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +00:00
Andreas Fabri ebe7bfebff Add assertion failure behaviour and move user manual section 2012-10-02 14:07:25 +00:00
Philipp Möller a2f6aa1d5e Minor grouping fixes, linebreaks. 2012-10-02 09:51:54 +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 33cd9af6cd Remove the last remnants of \require and turn them into \requires 2012-10-01 14:56:32 +00:00
Philipp Möller ab5c017c08 Unconditionally disable NO_TR1 defines.
Those cause trouble, because on MSVC the include paths for tr1
components are different from gcc. Instead of fixing up the include
paths depending on platform, just never use a tr1 component. Nothing
of value is lost compared to the boost equivalents and it removes
another code-path.
2012-09-28 13:15:14 +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
Philipp Möller 5bed1b15c5 Add basic Surface_mesh_parameterization, grouping and some moves to
internal are still missing
2012-09-14 11:15:18 +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 513eaf63f1 unlink 2012-09-10 20:18:45 +00:00
Philipp Möller ba70217acb document CGAL_ALLOCATOR in the public manual 2012-09-10 15:28:06 +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 76c5ca1899 typo 2012-08-27 19:58:06 +00:00
Laurent Rineau 2db4effa7e CMake: Fix the handling of cmake_policy
That is a followup-to my commit last year:
  | ------------------------------------------------------------------------
  | r63198 | lrineau | 2011-04-28 19:45:22 +0200 (Thu, 28 Apr 2011) | 5 lines
  | 
  | Try to fix my last revision about cmake_policy, with CMake-2.6.x
  | 
  | CMake gives an error if one tries to use cmake_policy(VERSION x.y.z) if
  | x.y.z is greater than the current CMake version.
  | 
  | ------------------------------------------------------------------------

The following check:
  if("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}" VERSION_GREATER 2.6)
is useless just after a call to:
 cmake_minimum_required(VERSION 2.6.2)



The script used to fix that was:


#!/usr/bin/env perl

$replacement=<<'END';
if("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}" VERSION_GREATER 2.8.3)
  cmake_policy(VERSION 2.8.4)
else()
  cmake_policy(VERSION 2.6)
endif()
END

while(<>) {
    if(/if\("\${CMAKE_MAJOR_VERSION}.\${CMAKE_MINOR_VERSION}" VERSION_GREATER 2.6\)/) {
        while(<>) {
            if(/^endif\(\)/) {
                print "$replacement";
                while(<>) {
                    print;
                }
                exit 0
            }
        }
    }
    print;
}
2012-08-22 12:35:03 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +00:00