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
Andreas Fabri
6e214c5f4a
remove Qt3 demos and empty dontsubmit files
2015-09-30 12:51:40 +02:00
Sébastien Loriot
9114db9085
restore figure source files removed in 0fa2cacb
...
| commit 0fa2cacb60
| Author: Sébastien Loriot <sebastien.loriot@cgal.org>
| Date: Tue Dec 3 17:27:02 2013 +0100
|
| remove doc_tex documentation (including developer manual) and old manual tools
2014-02-10 14:54:23 +01:00
Sébastien Loriot
0fa2cacb60
remove doc_tex documentation (including developer manual) and old manual tools
2013-12-03 17:27:02 +01:00
Laurent Rineau
4e5734b222
Improve doc of concepts Vertex and Face of HDSItems and PolyhedronItems
2013-09-16 15:04:19 +02:00
Laurent Rineau
bc03aaf30b
Put doc/ in the global dont_submit file
2013-08-20 10:57:03 +02:00
Sébastien Loriot
9c2f35ed1a
using cgalHeading instead of h3
2013-08-07 10:06:49 +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
Xiang Gao
882f5b8570
fix warning for unused parameter 'p'
2013-08-05 07:45:04 +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
74a1ac055e
remove pdf files from doxygen doc include path
2013-07-25 11:15:18 +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
4389b0bac8
remove the usage of gif in the doxygen doc as pdflatex does handle them
...
replace the files with png
2013-07-25 11:06:13 +02:00
Sébastien Loriot
716f87d2d7
rename Hidden_type to unspecified_type and update its description
2013-06-13 18:48:58 +02:00
Philipp Möller
fd0a2b46f4
Merge branch 'Documentation-remove-dxyassist-pmoeller'
2013-06-03 20:37:20 +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
Laurent Rineau
e128660348
Fix bad Doxygen formatting
...
If the first line of the comment is blank, that creates a <pre>
environment.
2013-05-30 12:10:13 +02:00
Sébastien Loriot
7e15467c72
new cgal doxygen advanced macro to put the text inside a div
2013-05-27 19:36:33 +02:00
Laurent Rineau
008ccc5b48
Add missing #include <cassert>
2013-04-25 11:20:36 +02:00
Laurent Rineau
b6ffa7c425
Merge branch 'CGAL-fix_warnings-GF'
...
That branch was successfully tested in CGAL-4.2-Ic-205.
2013-03-27 12:23:31 +01:00
Sébastien Loriot
9fcf46e11a
replace CGAL_[kernel/qpe/triangulation/]_assertion by assert in tests
...
this should be the case, following our guidelines.
using:
find */test/* -name '*.[hc]*' | xargs sed -i 's/CGAL_assertion/assert/g'
2013-03-21 10:50:55 +01:00
Sébastien Loriot
1fcb9e56c3
manual removal of last CGAL_assertion_code in tests
...
according to our guidelines, we should use assert so no need for
CGAL_assertion_code
for lines containing () or multi-line
2013-03-21 10:50:38 +01:00
Sébastien Loriot
3c7ad8410c
add classified reference manual pages
2013-03-12 15:07:19 +01:00
Sébastien Loriot
0eaad78779
doc typo
2013-03-04 07:56:26 +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
e1fb061598
first usage of CGAL_USE_TYPE
2013-01-31 14:16:08 +01:00
Sébastien Loriot
22cc8bf0b3
fix documentation and code of keep_largest_connected_components to match
...
During the review of Surface_mesh_reconstruction_3, this functions has been
asked to be moved into the HDS decorator, but without checking that it would
be working with a plain HDS. This patch fixes this and also the requirements
of the function.
2013-01-18 12:15:44 +01:00
Sébastien Loriot
fb4f7ac2ea
add documented but missing decorator functions
2013-01-18 11:30:29 +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
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
bfd1108392
Add Grouping
2012-11-23 15:54:09 +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
8d741d504d
remove % in section name
2012-11-14 16:10: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
5ee1081f92
using cgal macros for all figures
2012-11-08 17:17:29 +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
0c15e0f4cd
remove a paragraph about something deprecetated since CGAL 2.2
2012-10-31 10:17:32 +00:00
Andreas Fabri
bc1524f6ab
linking unlinking
2012-10-30 13:04:40 +00:00
Philipp Möller
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +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