Sébastien Loriot
0fa2cacb60
remove doc_tex documentation (including developer manual) and old manual tools
2013-12-03 17:27:02 +01:00
Andreas Fabri
6c547e5663
Mainly added includes
2013-09-13 22:24:30 +02: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
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
143a2181b3
add latex format for \imagei doxygen command
...
perl -pe 's/^(\s*)\\image\s+html\s+(.*)\s*$/$1\\image html $2\n$1\\image latex $2\n/' -i
2013-07-25 11:50:53 +02:00
Sébastien Loriot
08c9214275
doc: last replacements of \R by \mathbb{R}
2013-07-11 07:29: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
6cea5e34e7
add missing deprecated commands
2013-05-28 14:26:36 +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
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
d19578725b
Fix warnings
2013-02-07 18:15:23 +01:00
Laurent Rineau
e87dad0f95
Fix all warnings in demo/Polyhedron/
...
The compilation was fix g++-4.8, and the flags:
--std=c++11 -frounding-math Wall -Wno-array-bounds -Wno-uninitialized
2013-02-06 17:03:20 +01:00
Sébastien Loriot
6e63d3cfa8
adding missing () in see also for functions
2013-01-09 19:48:42 +01:00
Sébastien Loriot
ade462dbad
add () to function reference in classified ref man
2013-01-08 17:50:33 +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
5f3c8826d1
h2 is the first header in classified reference manuals
2013-01-07 09:00:48 +01:00
Sébastien Loriot
7e095c7a7a
Merge branch 'Documentation-flat-ref-manual-pmoeller'
2013-01-04 15:19:57 +01:00
Sébastien Loriot
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
Sébastien Loriot
3f90110479
remove section
2013-01-04 10:54:45 +01:00
Sébastien Loriot
077cdb60e5
wrong symbol
2013-01-04 10:54:36 +01:00
Sébastien Loriot
3c3ce61c5e
classified ref man for 2D Convex hull
2013-01-04 10:54:32 +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
9f45516fcf
add input for test file
2012-11-28 16:05:18 +01:00
Sébastien Loriot
b212c59dfc
BUG when not using the default traits, pass it to the function
2012-11-28 12:05:03 +01:00
Sébastien Loriot
98c8d8d811
remove exe property
2012-11-28 12:05:03 +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
a035e4959d
unlink and a better package illustration
2012-11-19 13:10:57 +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
35d7fd7540
fix linking
2012-11-02 20:30:37 +00:00
Philipp Möller
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +00:00
Andreas Fabri
200dd22df4
finished
2012-10-09 10:47:36 +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
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
Andreas Fabri
5d38dc1393
Add example that uses projection traits class
2012-09-26 21:01:42 +00:00
Andreas Fabri
5167bd1fe8
document the overload of convex_hull_2 to get rid of an obscure Default_traits()
2012-09-26 07:20:01 +00:00