Commit Graph

78 Commits

Author SHA1 Message Date
Jane Tournois e499208f5c add missing namespace 2017-11-13 15:27:07 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Sébastien Loriot 1fc7e45cde fix typo 2016-01-13 08:17:29 +01:00
Philipp Möller 71b4e9c515 Use CGAL_FULL_VERSION in all Doxyfile.in 2015-12-17 16:33:28 +01:00
Philipp Möller 81a8f982dc Handle the easy INPUT cases
If INPUT is just PKG/doc/PKG, handle it automatically.
2015-12-10 17:00:26 +01:00
Sébastien Loriot 6d5a92ebcb try to improve cgalRequires removal 2015-11-23 22:06:06 +01:00
Maxime Gimeno 7b4267c162 Replacement of cgalRequires
-fix for #291
2015-11-23 22:06:06 +01:00
Jane Tournois 717fa0a3fa fix doxygen warning 2015-05-19 10:02:28 +02:00
Jane Tournois 83c415bca9 move Mesh_optimization_return_code from Mesh_3 to Mesh_2
Mesh_3 already depends on Mesh_2,
but not the other way around
2015-05-19 08:54:36 +02:00
Jane Tournois 07bd45535c fix typo 2015-05-19 08:54:35 +02:00
Jane Tournois f2e7a860de fix link 2015-05-19 08:54:34 +02:00
Jane Tournois 5e9773f390 fix link to Mesh_optimization_return_code from Mesh_3 2015-05-19 08:54:34 +02:00
Jane Tournois 7886aca9e4 add a typedef 2015-05-19 08:54:33 +02:00
Jane Tournois 717e795c1a make the specification of DelaunayMeshFaceBase_2 complete
+ change access functions names to make them conform to CGAL
+ add preconditions in the code
2015-05-19 08:54:33 +02:00
Jane Tournois 7870b54c06 add figures to the documentation 2015-05-19 08:54:15 +02:00
Jane Tournois c83641b7ef fix sections : meshing examples of "meshes" back in the "Meshes" section 2014-11-28 09:53:00 +01:00
Jane Tournois f1afe6a2ef add documentation for lloyd_optimize_mesh_2 2014-11-27 16:23:55 +01:00
Jane Tournois 33dd5d441d update package description 2014-11-27 13:22:00 +01:00
Jane Tournois 0d90d763c1 add a link to lloyd_optimize_mesh_2 2014-11-27 13:11:28 +01:00
Jane Tournois fbd42eb3b4 list of examples updated 2014-11-27 13:10:38 +01:00
Jane Tournois d119879313 add namespace parameters for parameters of lloyd_optimize_mesh_2 2014-11-25 10:42:38 +01:00
Laurent Rineau 38e5dc102d Remove execution permissions 2013-11-13 14:05:43 +01:00
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
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
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 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
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
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 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