Commit Graph

476 Commits

Author SHA1 Message Date
Jane Tournois 4d039882f0 remove CGAL:: that causes compilation error on linux 2016-06-14 14:17:22 +02:00
Andreas Fabri ae1f695208 Document where sqrt is done approximately 2016-06-14 14:17:04 +02:00
Laurent Rineau 4c97ab6c96 Minor fixes for -Wconversion warnings in a few packages 2016-04-22 12:36:26 +02:00
Sébastien Loriot c869ee6855 update cmake scripts with at least one example requiring Core 2016-03-24 16:40:57 +01:00
Sébastien Loriot 4c29bf1b44 CMAKE_SOURCE_DIR -> CMAKE_CURRENT_SOURCE_DIR 2016-03-24 16:33:46 +01:00
Sébastien Loriot 881e4d3199 request Core only in examples, tests and demos when really needed 2016-03-07 22:36:57 +01:00
Sébastien Loriot 2d191d6651 commit CMakeLists.txt for all examples and tests 2016-03-07 17:39:36 +01:00
Marc Glisse 64866a966a typo implicit/explicit 2016-02-15 22:13:00 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +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
Sebastien Loriot 2e493f297b Merge pull request #389 from afabri/CGAL-Qt3-GF
Remove Qt3 based demos
2015-10-23 17:08:49 +02:00
Andreas Fabri e8632330d8 The result type is not unspecified 2015-10-06 17:35:04 +02:00
Andreas Fabri 6e214c5f4a remove Qt3 demos and empty dontsubmit files 2015-09-30 12:51:40 +02:00
Andreas Fabri 0c4902a2dc fix documentation in Nef_2 2015-03-23 11:03:32 +01:00
Andreas Fabri 2cee9fc33e Merge branch 'CGAL-misc_warnings-GF'
Approved by the release manager
2015-01-12 13:00:41 +01:00
Andreas Fabri a92e4101d8 Merge branch 'CGAL_workaround_counting_iterator-GF'
Approved by the release manager
2015-01-12 11:48:10 +01:00
Andreas Fabri 4705199cf8 use CGAL_UAE_TYPE 2015-01-08 10:17:07 +01:00
Andreas Fabri cf4d31ead5 use CGAL_USE_TYPE 2015-01-04 11:45:18 +01:00
Andreas Fabri 608f884cc7 restore accidentally removed line 2015-01-01 19:25:53 +01:00
Andreas Fabri ac15d8354e use CGAL_USE 2014-12-31 15:05:48 +01:00
Andreas Fabri 30faf6241b Add wrappers around 2 boost headers to push/pop pragma 2014-12-19 16:10:02 +01:00
Andreas Fabri 4d4859410e typo 2014-08-26 16:25:29 +02:00
Laurent Rineau 36d8b5bd18 Convert source files encoding to utf-8
All non-ASCII files should be encoded in UTF-8. So far, the ZSH script
`Scripts/developer_scripts/detect_wrong_encoding` detects wrong encoding
in source/header files of include/, src/, and doc/.
2014-08-01 11:20:13 +02:00
Laurent Rineau 495ed0b6ab Merge remote-tracking branch 'origin/CGAL-Less_warnings-GF'
Fix various warnings.

Tested in CGAL-4.5-Ic-97. Approved by the Release Manager.
2014-07-16 17:48:56 +02:00
Andreas Fabri 3e1237e7d8 Use CGAL_USE_TYPE 2014-07-03 14:44:46 +02:00
Laurent Rineau c18c93023a More #include
When CORE_arithmetic_kernel and LEDA_arithmetic_kernel are used, then
one should have:
  #include <CGAL/CORE_arithmetic_kernel.h>
  #include <CGAL/LEDA_arithmetic_kernel.h>
2014-06-24 18:10:07 +02:00
Laurent Rineau 73f4734525 Fix permissions 2014-05-15 18:33:36 +02:00
Efi Fogel 1ec2516b0e minor fix for master---replaced non utf8 characters in comments with utf8 2014-03-31 16:08:05 +03: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
Michael Hemmer 310ce5affa backquotes 2014-02-03 14:54:36 +01:00
Michael Hemmer 8f18eb46f9 improve documentation of ImplicitInteroperable 2014-01-30 13:57:14 +01:00
Laurent Rineau 4d721b8969 Fix a typo: RealComparable/RealEmbeddable 2013-12-17 15:39:27 +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
Sébastien Loriot 21fe94a3f1 update group name in doc
Approved by the release manager
2013-10-04 17:35:31 +02:00
Laurent Rineau d47f920919 Fix a compilation error
The error, on clang, is:

include/CGAL/Algebraic_structure_traits.h:362:39: error: declaration of 'Type_' shadows template parameter
            typedef typename CT::Type Type_;

The bug was introduced by the following commit:
  | commit 02e17dfdf0
  | Author: Michael Hemmer <mhsaar@gmail.com>
  | Date:   Mon Sep 2 18:28:55 2013 +0300
  |
  |     fixed boost::is_same<Type,Type>
  |
  |     minor fix for master
2013-09-09 14:07:00 +02:00
Michael Hemmer 02e17dfdf0 fixed boost::is_same<Type,Type>
minor fix for master
2013-09-03 09:29:54 +03:00
Andreas Fabri 50a4da2992 Put () after function names to increase readability 2013-08-28 15:14:25 +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
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
Andreas Fabri 5ef6b0d52e cleanup of classified reference pages; Move global functions in a group too 2012-10-10 13:33:03 +00:00
Laurent Rineau 9a3998357f svn merge --reintegrate \^/branches/features/CGAL_foundations-fix_missing_headers-lrineau 2012-10-10 12:39:36 +00:00
Andreas Fabri bdcb53abef Add a classified Reference page 2012-10-10 06:33:36 +00:00
Michael Hemmer 8cfa1699a3 update email 2012-10-09 11:52:16 +00:00
Laurent Rineau f8b9521b3b Fix headers of Algebraic_foundations
Mostly missing headers.

But sometimes I have removed the use of <CGAL/number_type_basic.h>, because
that header is hell for the moment.
2012-10-08 08:41:43 +00:00
Andreas Fabri 86f5f18679 linking 2012-10-05 13:18:58 +00:00
Andreas Fabri 63cec869c1 linking 2012-10-05 13:09:54 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +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