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
67a73344f3
fix linking issue
...
fig bug #15486
2013-07-25 13:58:48 +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
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
2ac05c6d95
fix warnings detected by doxygen 1.8.4
2013-05-24 12:49:02 +02:00
Sébastien Loriot
a18a34bbbe
Merge branch 'Algebraic_foundations-make_rational-glisse'
2013-04-15 16:37:31 +02:00
Alexandros Konstantinakis-Karmis
3b1d281efb
Abbreviations trigger end of \brief description
...
Fixes bug #15482 :
https://gforge.inria.fr/tracker/index.php?func=detail&aid=15482&group_id=52&atid=13845
2013-03-13 11:58:56 +01:00
Sébastien Loriot
7e59c14580
add a header to classified reference pages using a doxygen macro
2013-03-12 14:33:49 +01:00
Andreas Fabri
e6d101d9fb
remove unused typedefs
2013-03-05 11:50:05 +01:00
Marc Glisse
48388241a0
Add make_rational(FT) and make_rational(pair).
2013-02-22 15:47:20 +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
51ea960be6
Fix warnings about unused types or variables.
2013-02-08 16:50:02 +01:00
Andreas Fabri
c029f702a3
use more types
2013-02-07 11:02:14 +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
609925675b
add a trailing _ to the namespaces of the concepts in Algebraic Foundations
...
No more warning!
2013-01-24 19:16:40 +01:00
Sébastien Loriot
3b81e2d1a4
fix warnings in algebraic foundations
...
to fix the remaining warnings we need a strategy to disambiguate
the typedef vs. the concept
2013-01-20 12:21:53 +01:00
Sébastien Loriot
6e63d3cfa8
adding missing () in see also for functions
2013-01-09 19:48:42 +01:00
Sébastien Loriot
b0bd160355
add missing back-ticks in see also
2013-01-09 19:48:41 +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
5f3c8826d1
h2 is the first header in classified reference manuals
2013-01-07 09:00:48 +01:00
Sébastien Loriot
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
Philipp Möller
0b5021a461
Flatten the modules and integrate the Classified Reference
2012-12-18 22:09:21 +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
Sébastien Loriot
947f6352bc
backport commit in tex file from master into doxygen
2012-11-23 15:29:38 +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
4fa2db4a48
change \sa ::FOO into \s `FOO`
...
using:
perl -pi -e 's/\\sa\s+::([A-Za-z0-9_:]+)\s*/\\sa `$1`\n/'
2012-11-23 09:18:35 +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
936a94fc5e
missing ref
2012-11-15 09:16:45 +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
974621b58f
start using new figure macros.
...
For Combinatorial maps, I reintroduced the original anchor names as they
were still in use in the reference manual.
2012-11-08 10:55:09 +00:00
Sébastien Loriot
ae159cbdf3
replace markup #, ##, ### by \section, \subsection and \subsubsection
...
(script replacement)
2012-11-06 22:02:15 +00:00
Sébastien Loriot
297ed62c30
decrease level
2012-11-06 20:50:00 +00:00
Sébastien Loriot
34d6728763
remove exe property
2012-11-06 15:54:42 +00:00
Andreas Fabri
d981d9aadf
typo
2012-11-02 10:59:50 +00:00
Andreas Fabri
7a6634b5a7
No need for CGAL:: in user manuals
2012-10-31 20:11:16 +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
Michael Hemmer
f70c98a99c
improve doc
2012-10-17 14:40:17 +00:00
Andreas Fabri
92e32a4f8a
fix (old) linking problem
2012-10-15 09:53:30 +00:00
Andreas Fabri
5a8b3c2ea9
fix (old) linking problem
2012-10-15 07:22:45 +00:00
Philipp Möller
b7ae09f4a6
Better linking to Tag_true
2012-10-12 13:25:24 +00:00