songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
99,694 Commits 3 Branches 156 Tags 965 MiB
Commit Graph

73 Commits

Author SHA1 Message Date
Mael Rouxel-Labbé 472dd09a02 Misc doc cleaning 2020-12-05 15:18:34 +01:00
Mael Rouxel-Labbé 723890e388 Misc tiny doc fixes (broken links, grammar, etc.) 2020-12-05 11:49:27 +01:00
Mael Rouxel-Labbé 702d2ddf86 Fix documentation of TDS vertex/face/cell requirements in TDS-using classes 2020-12-05 11:42:21 +01:00
Mael Rouxel-Labbé f4300bbacd Add some missing const / references in documentations 2020-12-05 11:20:26 +01:00
Mael Rouxel-Labbé 6b87fe393d Fix various grammar issues 2020-12-05 11:11:33 +01:00
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 cf99ea072d Merge remote-tracking branch 'cgal/releases/CGAL-4.14-branch' 2020-03-16 16:19:38 +01:00
Mael 22b0cc6efb
Fix typo 2020-03-10 16:40:50 +01:00
Mael Rouxel-Labbé 0729d1b0d1 Update documentations of SDG/AG2: Filtered_exact has been removed... 
... 16 years ago !
 2020-03-10 15:17:50 +01:00
Mael Rouxel-Labbé bd9610446d Fix some links in Apollonius_graph_2's documentation 2020-03-10 14:54:44 +01:00
Andreas Fabri 4581f1b7a8 Morte replacements 2019-06-05 08:39:55 +02:00
Andreas Fabri e2d19b0c8d Replace NULL and Nullptr_t with nullptr and nullptr_t 2019-06-04 23:45:44 +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 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
Mael Rouxel-Labbé 41d9ea692d Fixed refinement relationship in Apollonius_graph_2 
AG2 inherits T2 so naturally the GT and Vb must be models of the T2 concepts
 2017-06-28 10:15:30 +02: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
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 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 0653914893 doc: put \image at the beginning of the line and nothing at eol 2013-07-25 11:32:07 +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
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 7e59c14580 add a header to classified reference pages using a doxygen macro 2013-03-12 14:33:49 +01:00
Sébastien Loriot ef1b8db680 prevent linking to IO files (the doc is where it relates to) 2013-01-31 18:35:37 +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 8daada2ce6 start classified ref man at h1 2013-01-04 14:59:28 +01:00
Philipp Möller 8bebe6abc7 Added classified to Apollonius_graph 2012-12-19 12:36:31 +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
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 b97a633dd0 use \image instead of htmlonly and <img> 2012-11-08 18:36:54 +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 d163ad1ce3 new macros for multipule images and special cases 
use a new div class for figure caption with a new css rule
update alpha-shape-3 and apolonnius user manual to use them
 2012-11-01 08:54:08 +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
Philipp Möller 81c8c662d6 Fix some PkgDependsOn to stay inside the package overview, fix an 
off-by-one in hacks.js, add a missing dependency
 2012-10-18 16:31:12 +00:00