Commit Graph

68 Commits

Author SHA1 Message Date
Andreas Fabri 4b89f17b42 CGAL: An Halfedge 2025-11-03 14:37:50 +00:00
Sébastien Loriot 13609a6966 no need to repeat the package name as it is on the line above 2025-05-22 17:53:41 +02:00
Daniel Funke 14a306dff4 add doc 2023-10-10 16:43:00 +02:00
Laurent Rineau fc61b42864 Merge pull request #6858 from sloriot/Doc-exclude_internal
Ignore internal directories
2023-01-27 21:02:29 +01:00
Sébastien Loriot 96c465bf99 there is no longer any example 2022-12-20 15:54:34 +01:00
Sébastien Loriot fef1a43d35 remove internal from generated doc 2022-12-15 10:43:27 +01:00
Mael 0ff7882997
Merge branch 'master' into feature/bug_documentation_spell_20221113 2022-12-06 22:21:06 +01:00
Mael Rouxel-Labbé b5c21e1f5d Http -> https + update some dead links 2022-11-23 18:54:37 +01:00
albert-github 7a62583efa spelling corrections
Some spelling corrections (Directories starting with `C`)
2022-11-14 19:14:33 +01:00
Mael Rouxel-Labbé 0d66e19361 IO documentation fixes
See @sloriot's review:

https://cgal.geometryfactory.com/CGAL/Members/wiki/Features/Polgyon_soup_mesh_IO/2nd_round/Answer_to_review

(+ some commits before and after this one)
2020-07-24 17:06:00 +02:00
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Andreas Fabri a472c24185 http:/www.boost.org -> https://www.bost.org 2019-03-20 08:59:22 +01:00
Andreas Fabri 7c2674abc8 More links fixed 2019-03-20 08:38:40 +01:00
Sébastien Loriot 59bc453b42 first batch of replacement for level 1 in classified ref man
command used:
grep -l  "##" */doc/*/PackageDescription.txt | xargs  sed -i  -E 's/\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\s*$/\\cgalCRPSection{\1}/'
2019-02-14 10:32:39 +01:00
Sébastien Loriot ea240cfac5 use \PkgXXX instead of \PkgXXXSummary 2018-10-08 10:28:44 +02:00
Sébastien Loriot a2e8a1c68f add the suffix Ref to doxygen link to reference 2018-10-08 10:26:56 +02:00
Marc Glisse 5cfb55a9e6 New ipelet: minimum spanning tree. 2018-04-16 19:21:32 +02:00
Frédérik Paradis 7369b842a4 Adding doc for the cone spanners ipelet 2016-12-01 15:58:53 -05: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 4f553891fd Handle non-default example directories
while making sure that this is agnostic to the file layout
2015-12-10 17:05:51 +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
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Olivier Devillers d9cdb1f580 There was a bug in the computation of pencil of circles:
degenerate case when circle degenerate in the radical axis
were not taken in account.

This has an implact on the ipelets "pencil of circels"and "hyperbolic".

A very small ipelet computing the distance between two points is also added.
2014-08-01 15:20:23 +02:00
Sébastien Loriot d8ccdab0a4 update user manual 2013-12-16 23:05:10 +01:00
Sébastien Loriot 29ad4556e7 make the name of subfunctions matching with the doc and the help menu 2013-12-16 17:40:27 +01:00
Olivier Devillers fee948e406 misc (following Sebastien remarks) 2013-12-16 16:19:29 +01:00
Olivier Devillers 9c4785f884 additional features in hyperbolic ipelet 2013-12-10 11:33:28 +01:00
Olivier Devillers 0eb0367883 detail 2013-12-05 09:19:46 +01:00
Olivier Devillers c05c0a556f apply Sebastien comments 2013-12-05 09:11:35 +01:00
Olivier Devillers 1752d3605c adding policies in Hilbert sort
adding doc of the CGAL_ipelet demo
2013-11-27 17:28:14 +01:00
Sébastien Loriot 64f38d2703 add missing group 2013-08-07 10:48:16 +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
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 d4e379ba82 Small fixes in the generated Doxyfile.in 2013-05-30 15:32:33 +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
Sébastien Loriot 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Sébastien Loriot c41bcc8999 remove empty groups 2013-03-14 09:36:56 +01:00
Andreas Fabri 37b7f0054f output_iterator -> OutputIterator; ipelets depend on Polygon package 2013-03-14 09:08:08 +01:00
Sébastien Loriot 7d2903e230 add classified reference manual pages 2013-03-12 14:51:52 +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 1d5b7dec76 correct linking and remove section 2012-11-22 11:50:29 +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 ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection
(script replacement)
2012-11-06 22:02:15 +00:00
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00