songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
53,033 Commits 3 Branches 156 Tags 974 MiB
Commit Graph

278 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 b2ef3b8673 Merge branch 'doc-remove_gif-local' 
Successfully test in CGAL-4.3-Ic-102

This commit fixes a few issues in the doxygen documentation and in particular
the figure for the generation of latex doc.

Approved by the interim release manager

xplain why this merge is necessary,
 2013-07-26 17:50:07 +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 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +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 7e59c14580 add a header to classified reference pages using a doxygen macro 2013-03-12 14:33:49 +01:00
Sébastien Loriot 7a6aa123d7 add classified reference manual for Mesh_2 2013-03-12 13:36:15 +01:00
Andreas Fabri 876a4a5753 remove unused variables and #if 0 buggy non used code 2013-02-26 17:05:13 +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 66c5d23154 Use CGAL_assume to remove warnings 2013-02-20 18:55:43 +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 9fea4e7c99 one less warning in Mesh_2, Point_set_2 2013-01-30 18:49:40 +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
Andreas Fabri 0ee845a9cc polish Mesh_2 2012-12-27 20:58: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 9c79cb5c7f backport commit in tex file from master into doxygen 2012-11-23 18:16:59 +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
Andreas Fabri 3447d93aa2 typo 2012-11-23 11:46:13 +01:00
Andreas Fabri 8d3c6a9bb9 polish Mesh_2 2012-11-23 11:44:39 +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
Sébastien Loriot 2607d8b7b9 missing { and extra latex 2012-11-19 16:32:51 +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 5ee1081f92 using cgal macros for all figures 2012-11-08 17:17:29 +00:00
Sébastien Loriot 0e2b61845c replace markup #, ##, ### by \section, \subsection and \subsubsection 
(manual replacement)
 2012-11-06 22:24:02 +00:00
Sébastien Loriot ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection 
(script replacement)
 2012-11-06 22:02:15 +00:00
Andreas Fabri 6abaad0be3 No need for :: as prefix in backquotes 2012-10-31 20:52:33 +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
Laurent Rineau 3ee271ea18 Add documentation that Projection_traits_xy_3 is a model of 
DelaunayMeshTraits_2
 2012-10-16 14:53:13 +00:00
Laurent Rineau b4c3b341ba Make Projection_traits_3 compatible with Mesh_2 
And add one test.
 2012-10-16 14:46:46 +00:00
Laurent Rineau 795c71fc9b Fix headers of Mesh_2 and Mesh_3. All were missing #include. 
I found out that way that <CGAL/Mesh_3/Refine_facets.h> and
<CGAL/Mesh_3/Protect_edges_sizing_field> were using global functions
instead of functors of the traits class.

Note also the funny bug that <CGAL/Regular_triangulation_cell_base_3.h> was
depending on <CGAL/Triangulation_vertex_base_3.h>!
 2012-10-08 09:33:38 +00:00
Laurent Rineau 0a081c2abd Add an option to check the syntax of headers, individually. 
That feature can be enabled with g++, clang++, and icpc (intel). It could
be implemented for MSVC, with the flag /Zs, but that is not yet done (and
probably will not).

The option is controlled by a CMake option, CGAL_ENABLE_CHECK_HEADERS, that
is disabled by default. If that option is enabled by the user, then CMake
will check if the compiler $CXX understand the syntax:
  $CXX -x c++ -fsyntax-only CGAL/header.h
and send an error otherwise.

Then phony targets will be created:
  - a target check_CGAL__header_h for each header <CGAL/header.h>,
  - a target check_pkg_<pkg> for each package <pgk>,
  - and a target check_headers for the whole CGAL.

Those new targets currently give a lot of compilation errors if
CGAL_ENABLE_CHECK_HEADERS is enabled!

+ fix several missing includes in Mesh_2.
 2012-10-05 12:21:44 +00:00
Laurent Rineau ac31600c60 Mesh_2 documentation verify by the author 
Remove the \todo
 2012-10-04 08:09:52 +00:00
Laurent Rineau b4ab505a42 Fix syntax 
- de-LateXify the parameter names,
- avoid `quotes` on more than two lines.
 2012-10-03 13:20:36 +00:00
Laurent Rineau c5ee6400c1 Use lists in the description of MeshingCriteria_2::Is_bad. 
That is infinitely better than with the LaTeX manual tools!
 2012-10-03 13:06:50 +00:00
Laurent Rineau 44d051d631 Uniformly s/SqrtFieldNumberType/FieldWithSqrt/g 
SqrtFieldNumberType is no longer documented. (For how long?)

I have also rephrase "A `SqrtFieldNumberType`" to "A model of the
`SqrtFieldNumberType` concept", that sounds more correct.
 2012-10-03 12:10:00 +00:00
Laurent Rineau d84e60c1f6 Typo in a return type 2012-10-03 12:04:17 +00:00
Andreas Fabri 16992d9713 change link for \ccDepends 2012-10-03 11:00:43 +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 e54098fb57 Throw out left over Classified files and move their content if 
necessary.
 2012-09-20 16:29:19 +00:00