Commit Graph

121 Commits

Author SHA1 Message Date
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
Laurent Rineau bc03aaf30b Put doc/ in the global dont_submit file 2013-08-20 10:57:03 +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
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 e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +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
Andreas Fabri 13bac84716 less warnings in various packages 2013-02-01 10:27:07 +01:00
Andreas Fabri 9fea4e7c99 one less warning in Mesh_2, Point_set_2 2013-01-30 18:49:40 +01:00
Sébastien Loriot 318c280932 less linking 2013-01-07 19:26:50 +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
Sébastien Loriot 82b2ebc865 apply the cpp0x namespace renaming in all files 2012-12-19 11:33:17 +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 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 3e388ca7f5 Add Grouping 2012-11-23 16:13:36 +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 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
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 81c8c662d6 Fix some PkgDependsOn to stay inside the package overview, fix an
off-by-one in hacks.js, add a missing dependency
2012-10-18 16:31:12 +00:00
Laurent Rineau ab866f899c Rename a test.
There was another target of the same name in ../../examples
2012-10-05 15:00:03 +00:00
Philipp Möller 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +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 9d96057636 Add PkgDependsOn to the package summary 2012-09-27 11:13:37 +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 74e0b77e05 whitespace 2012-09-04 11:30:40 +00:00
Andreas Fabri 37d41fdc03 more de-math 2012-09-04 10:10:22 +00:00
Andreas Fabri 98942e2f96 de-math 2012-09-04 10:04: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 af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +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 6a45864c1a Throw a set of ported doc files under version control 2012-08-09 16:07:44 +00:00
Philipp Möller b529971917 Merge the changes to ccPrecond and ccPostcond that have been in
features/doxy-pmoeller and add changes for ccRequires on top of it.

ATTN: This changeset should be unmerged before the whole branch goes
      back into next.
2012-06-20 13:57:36 +00:00
Andreas Fabri f1ab3edb2d Fix for Windows 'min/max' bug 2012-01-18 10:59:39 +00:00
Laurent Rineau a37c74d534 Add license files, per package 2012-01-16 15:54:22 +00:00
Laurent Rineau 2af2160942 Turn \ccLicenseQPL into \ccLicenseGPL 2012-01-13 17:13:55 +00:00
Laurent Rineau 8f59fd9592 Turn QPL into LGPLv3+ 2012-01-13 16:33:35 +00:00
Laurent Rineau 93486787c3 The inside of ccPkgDescription must not contain black lines between macros
Otherwise that inserts a buggy "<p>" tag in the package overview where the
doctype does not allow it.
2011-11-15 19:16:23 +00:00
Laurent Rineau fdb7ea6c6b prepare ccPkgHowToCiteCgal for CGAL-3.10 (in 2012) 2011-09-28 16:15:05 +00:00