Commit Graph

144 Commits

Author SHA1 Message Date
Maxime Gimeno c013d9d292 Clean-up
- Replace Mesh by TriangleMesh
- update changes.html and doc sections
- remove useless .off in examples
2016-09-28 10:48:07 +02:00
Maxime Gimeno 2912b9d40b Fixes in the doc 2016-09-28 10:46:42 +02:00
Maxime Gimeno 64c0a0d620 add an image to the User Manual. 2016-09-28 10:45:48 +02:00
Maxime Gimeno ee6731e625 Fix generator on triangle mesh 3 2016-09-28 10:45:47 +02:00
Maxime Gimeno 1d5d17cfd8 Clean-up 2016-09-28 10:45:47 +02:00
Maxime Gimeno b4578e9262 Add see also and name in PkgDescription 2016-09-28 10:45:47 +02:00
Maxime Gimeno 18a2cdd59c Add examples 2016-09-28 10:45:47 +02:00
Maxime Gimeno ec73440ab7 Update of the doc. 2016-09-28 10:45:46 +02:00
Maxime Gimeno 04f589e97d Update doc for Random_points_on_triangle_mesh_2 2016-09-28 10:45:46 +02:00
Andreas Fabri 6554072006 Update Generator.txt 2016-09-28 10:00:39 +02:00
Clement Jamin 5c64e418f6 Add a note about CGAL::Random not being fully thread-safe 2016-04-14 14:49:11 +02:00
Laurent Rineau 8716303dd9 Doc: add "Use `get_default_random()` instead." 2016-03-09 17:03:44 +01:00
Clement Jamin fccabf779f Deprecate default_random in doc 2016-03-09 14:27:22 +01:00
Clement Jamin 9a61b23b55 Use get_default_random() instead of default_random 2016-03-09 10:35:21 +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
Maxime Gimeno 7b4267c162 Replacement of cgalRequires
-fix for #291
2015-11-23 22:06:06 +01:00
Sébastien Loriot 3f6c6b3369 Merge branch 'Generator-more_point_generators-pmachado' of git://github.com/sloriot/cgal into sloriot-Generator-more_point_generators-pmachado
Conflicts:
	Generator/doc/Generator/Generator.txt
	Generator/doc/Generator/PackageDescription.txt
	Generator/doc/Generator/examples.txt
	Installation/changes.html
2015-04-15 16:25:34 +02:00
Sébastien Loriot eeff9b601a fix link and add missing group 2015-03-31 16:15:42 +02:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Remy Thomasse 30c93188c5 doc: zero becomes origin 2015-01-06 16:53:48 +01:00
Remy Thomasse 2b9bfcf337 Left_turn_2 no longer needed 2015-01-06 16:53:48 +01:00
Remy Thomasse aa374e3e99 reference biblio 2015-01-06 16:53:47 +01:00
Remy Thomasse a0fdbe9ab0 petits ajustements anglais doc 2015-01-06 16:50:15 +01:00
Remy Thomasse 1a75179c94 petits ajustements doc 2015-01-06 16:50:14 +01:00
Remy Thomasse 76377e1463 Enorme typo sur le parametre fast 2015-01-06 16:50:14 +01:00
Remy Thomasse be57b3f2e6 typo 2015-01-06 16:50:14 +01:00
Remy Thomasse 5a876394d9 documentation+concept RandomConvexHullTraits_2 2015-01-06 16:50:14 +01:00
Remy Thomasse 03ef4e6789 modifications OutputIterator 2015-01-06 16:50:14 +01:00
Remy Thomasse 9e6fc4f698 typo 2015-01-06 16:50:13 +01:00
Remy Thomasse 616178e80f name change, typos 2015-01-06 16:50:13 +01:00
Remy Thomasse 8bb8668a03 documentation 2015-01-06 16:50:13 +01:00
Remy Thomasse d350d0e51b doc 2015-01-06 16:50:13 +01: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
Pedro Machado Manhaes de Castro 6d7138ab89 Adjustements in the doc due to Sebastien's report of the small feature submission. 2013-10-14 18:09:00 -03:00
Pedro Machado Manhaes de Castro 79e3ea8ee2 Adding author information to the doc. 2013-10-14 12:36:14 -03:00
Pedro Machado Manhaes de Castro 386fe6eb09 stable stuffs done in gsoc2013, random points in triangle_2, triangle_3, and tetrahedron_3 2013-10-04 11:59:03 -03: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
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 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
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
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 1675f4da1a /name -> \name 2013-02-13 16:53:09 +01:00
Sébastien Loriot ebd2f15dd1 follow up of 601fd3b9: adding missing () in see also for functions 2013-01-09 19:48:43 +01:00
Sébastien Loriot 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +01:00
Sébastien Loriot e261f3b17b add missing examples 2013-01-09 19:48:42 +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 42d15a11d0 using uniform markups in classified reference pages 2013-01-04 15:16:40 +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 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 4554026ed0 backport commit in tex file from master into doxygen 2012-11-23 16:59:19 +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 2155cd6c9b Polish Geometric Object Generators 2012-11-22 12:32:47 +01:00
Sébastien Loriot 0f69c2a512 remove cpp0x namespace from documentation pages 2012-11-14 16:16:15 +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 6abaad0be3 No need for :: as prefix in backquotes 2012-10-31 20:52:33 +00:00
Andreas Fabri 59877a8d52 linking and unlinking 2012-10-30 13:40:03 +00:00
Philipp Möller f9fd30e2a9 integrate the classified page 2012-10-30 13:28:28 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 3200767818 typo 2012-10-13 12:34:56 +00:00
Andreas Fabri 65b4b91380 finished 2012-10-07 10:03:01 +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
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
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller 2d8931167f autoexamples 2012-08-29 16:20:55 +00:00
Philipp Möller 5a0a5403c4 Enable autotoc on mainpages 2012-08-29 15:45:17 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 9375a5e04a fix linking in \hasModel by backquoting 2012-08-27 13:08:43 +00:00
Andreas Fabri 2476654eeb \require -> \requires 2012-08-21 13:01:20 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +00:00
Andreas Fabri 3dfd7031c2 Remove whitespace 2012-08-20 18:30:46 +00:00
Philipp Möller d3a9a641de Refurb package descriptions with a label for the license. 2012-08-20 14:28:36 +00:00
Andreas Fabri 115c25c207 \warning, ###Requires, i.e., whitespace 2012-08-20 14:15:10 +00:00
Andreas Fabri c1dac5e0db In order to be linked functions need a () 2012-08-17 14:56:15 +00:00
Philipp Möller 6a45864c1a Throw a set of ported doc files under version control 2012-08-09 16:07:44 +00:00