Commit Graph

59 Commits

Author SHA1 Message Date
Sébastien Loriot 0779373835 extra run of the script to remove tabs and trailing whitespaces
right after the  merge of 4.14 release branch

+ manual fix on one line in:
    * Arrangement_on_surface_2/include/CGAL/IO/Arr_text_formatter.h
    * .travis/generate_travis.sh
2020-03-26 14:16:06 +01:00
Sébastien Loriot 0a46621dc6 Merge branch 'cgal/releases/CGAL-4.14-branch'
whitespace+tab removal, merged with option -Xignore-all-space
2020-03-26 13:28:46 +01:00
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Sébastien Loriot fbafb9d06f fix remaining mismatches and fix bugs 2019-07-10 11:40:45 +02: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 90ad079eb4 use macro for subsections
command used:
grep -l  "###" */doc/*/PackageDescription.txt |  xargs sed -i  -E 's/\#\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\#\s*$/\\cgalCRPSubsection{\1}/
2019-02-14 10:32:00 +01:00
Laurent Rineau 821f9c015e Merge pull request #3311 from sloriot/Doc-Pkg_link_name
Update the name of package names reference links
2018-10-29 10:27:53 +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
Iordan Iordanov 16a8c93db0 Small bugfix (citation error in Design and Implementation History) 2018-09-24 14:35:53 +02:00
Sébastien Loriot 19adf3b05e make the doc match struct/class with the implementation 2017-11-17 11:34:55 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Sebastien Loriot 32a3972c33 Merge pull request #592 from afabri/CGAL-dont_submit_cleanup-GF
Towards getting rid of dont_submit files
2016-01-08 14:14:08 +01:00
Andreas Fabri a41165b6eb various 2016-01-05 18:04:14 +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
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Sébastien Loriot 0e22279452 add missing space 2014-12-04 15:50:13 +01: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 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 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 c692bba14d Minor fixes to documentation 2013-03-13 12:18:25 +01: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
Sébastien Loriot 06e2aee35f doc bugfix: missing nested type in CK2 2013-02-13 15:28:13 +01:00
Sébastien Loriot 7ecf2981af rename kernel global function groups 2013-01-09 19:48:39 +01:00
Sébastien Loriot 5a641325e2 fix function references in CK2 and CK3 2013-01-08 17:50:32 +01:00
Sébastien Loriot 0aaa77de4a fix linking to intersection and do_intersect overloads 2013-01-08 17:50:29 +01:00
Sébastien Loriot 112e4e45d8 fix function linking 2013-01-08 17:50:29 +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 df08193e00 using \link command instead of \ref command to have the tt font 2013-01-07 16:21:46 +01:00
Sébastien Loriot 66e2348742 avoid linking Kernel 2013-01-07 09:49:05 +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
Sébastien Loriot e9f018e3dd classified ref man for Circular Kernel 2 2013-01-03 09:44:37 +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 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 151d636fa4 Add Line_2 to the CirularKernel concept 2012-11-20 12:30:07 +01:00
Andreas Fabri bc7dad48f5 fix linking 2012-11-20 11:43:44 +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 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
Sébastien Loriot 3980b3cc2d prettify + fix group 2012-10-11 08:32:57 +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