Commit Graph

63 Commits

Author SHA1 Message Date
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Sébastien Loriot 3169b23528 doc fix: use cgalExample macro 2014-04-24 14:56:33 +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 ee3ce8985f fix the way the specialization of graph_traits are documentated 2013-12-03 12:03:00 +01:00
Sébastien Loriot 21d3cbd2bb doc: add a return to line before heading 2013-09-23 16:37:34 +02:00
Sébastien Loriot c801ccfe36 doc bugfix: add a sentence about a deprecated requirement 2013-09-23 08:40:54 +02:00
Andreas Fabri 7349ad7caa Replace ** with \b 2013-08-19 14:14:49 +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 0a2f31ce90 doc bugfix: fix template parameters 2013-07-29 10:07:51 +02:00
Sébastien Loriot 3b1c661634 doc bugfix: missing nested type in concept 2013-07-29 09:55:44 +02:00
Sébastien Loriot ed76911e06 Merge branch 'AABB_tree-fix_non_conventional_names-local'
Successfully tested in CGAL-4.3-Ic-101
Approved by the interim release manager

This merge fixes documentation bugs and rename classes with names
non conform to CGAL conventions
2013-07-25 18:56:17 +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 ddda698034 inline the nested class Intersection_and_primitive_id in the documentation 2013-07-24 17:06:35 +02:00
Sébastien Loriot a10c77ab03 typo in doc 2013-07-24 16:50:20 +02:00
Sébastien Loriot 9c0808cad1 fix name of classes that do not respect CGAL naming conventions
AABB_HalfedgeGraph_segment_primitive -> AABB_halfedge_graph_segment_primitive
AABB_FaceGraph_triangle_primitive -> AABB_face_graph_triangle_primitive
2013-07-23 17:46:50 +02:00
Sébastien Loriot 2bf7690f57 rename template parameter cache_datum to CacheDatum
template parameter should be camel case
2013-07-22 14:52:16 +02:00
Sébastien Loriot 376e99312e Merge branch 'AABB_tree-one_primitive_per_object-sloriot'
Successfully tested in CGAL-4.3-Ic-68
implements what is described in Small_Features/aabb_tree_more_primitives
2013-06-24 08:11:05 +02:00
Sébastien Loriot 9934b020c6 fix the triangle FaceGraph primitive to work with Polyhedron 2013-06-19 18:02:05 +02:00
Andreas Fabri 914f60234c fix typo 2013-06-19 14:12:08 +02:00
Sébastien Loriot c3b717e4a5 correct introduction release 2013-06-19 07:56:30 +02:00
Sébastien Loriot 06fc6dc039 add the doxygen documentation corresponding to the doc_tex modifications 2013-06-18 19:55:20 +02:00
Sébastien Loriot c09ec2beaa Merge branch 'Kernel-replace_object-pmoeller'
Successfully tested in CGAL-4.3-Ic-59
Approved by the release manager

Conflicts:
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
	Kernel_d/doc/Kernel_d/Kernel_d.txt
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-06-14 14:26:05 +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 f118e7c6eb Clean up the files we use as examples 2013-05-31 11:40:35 +02:00
Philipp Möller 895245426a Fix some errors introduced by adding the titles 2013-05-30 18:09:42 +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
Ross Hemsley c0690f87f4 Manually inserted tags that could not be generated automatically
added in options that were in XML but were not moved across to new Doxyfile.in files.
2013-05-30 14:45:18 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Philipp Möller 0ade43576f Add configuration building 2013-05-30 11:45:37 +02:00
Ross Hemsley 2e9144ea16 Files that Philipp wanted to test Cmake for Doxygen 2013-05-30 11:13:08 +02:00
Sébastien Loriot 34362d2a0f update how Intersection_and_primitive_id get the type and update its doc
We use meta programming to remove the optional rather than relying on
Intersection_traits (since it depends on GeomTraits)
2013-05-23 12:31:42 +02:00
Sébastien Loriot 7e6a880aa4 update AABB_tree documentation 2013-05-23 10:56:42 +02:00
Sébastien Loriot d6905c61be Merge branch 'Kernel-replace_object-pmoeller-old' into Kernel-replace_object-pmoeller
Conflicts:
	AABB_tree/include/CGAL/AABB_tree.h
	Circular_kernel_2/include/CGAL/Circular_kernel_2/internal_functions_on_line_arc_2.h
	Intersections_3/include/CGAL/Intersections_3/intersection_3_1_impl.h
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-03-14 10:29:31 +01:00
Sébastien Loriot 7d2903e230 add classified reference manual pages 2013-03-12 14:51:52 +01:00
Andreas Fabri d16be07906 polish AABB Tree 2012-12-27 20:36:04 +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
Andreas Fabri a3e399028e typo 2012-12-05 19:37:51 +01:00
Andreas Fabri e0acf10424 doc_tex -> doxygen of the AABB Tree documentation 2012-12-05 14:37:56 +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
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller c48ef2954c Small fixes 2012-10-17 08:36:09 +00:00
Sébastien Loriot a484b9ba7d remove todo 2012-10-10 21:00:18 +00:00
Sébastien Loriot 9b44f4f7d8 AABB_tree is finished 2012-10-10 12:31:37 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +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
Philipp Möller b64ba48134 The changes to move the package overview labels into the
PackageDescription.
2012-09-25 17:17:49 +00:00
Philipp Möller 1954eff3d6 * build normalized mainpage anchors
* better naming for Pkg commands
* User and Reference Manual links from the PackageOverview
2012-09-20 15:30:03 +00:00
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00