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

53 Commits

Author SHA1 Message Date
Sébastien Loriot fa9d76dd08 remove documentation of deprecated classes 2014-06-02 08:07:25 +02:00
Sébastien Loriot e09a984da5 document hull subsequence functions uniformally 2014-02-03 19:26:01 +01:00
Sébastien Loriot 8b981deb12 remove untested sample code and refer to an example instead 2014-02-03 19:14:01 +01:00
Panagiotis Cheilaris c94644b324 ch_graham_andrew_scan() documentation fix 
I clarified the documentation, by putting closer to the top some
details about ch_graham_andrew_scan(), especially the precondition.

I also updated the ch_graham_anderson() example in the documentation.

TODO: Investigate more:
In my system, the following line in the example:

  *result = *(V.rbegin());  ++result;

is rendered without the first `*' in the HTML documentation.
 2014-01-31 14:47:55 +01: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 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 08c9214275 doc: last replacements of \R by \mathbb{R} 2013-07-11 07:29: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
Sébastien Loriot 6cea5e34e7 add missing deprecated commands 2013-05-28 14:26:36 +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 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +01:00
Sébastien Loriot ade462dbad add () to function reference in classified ref man 2013-01-08 17:50:33 +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
Sébastien Loriot 3f90110479 remove section 2013-01-04 10:54:45 +01:00
Sébastien Loriot 077cdb60e5 wrong symbol 2013-01-04 10:54:36 +01:00
Sébastien Loriot 3c3ce61c5e classified ref man for 2D Convex hull 2013-01-04 10:54:32 +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 a035e4959d unlink and a better package illustration 2012-11-19 13:10:57 +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 35d7fd7540 fix linking 2012-11-02 20:30:37 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 200dd22df4 finished 2012-10-09 10:47:36 +00:00
Andreas Fabri b8b7a5dad3 get rid of spurious XX 2012-10-03 17:02:54 +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
Andreas Fabri 5167bd1fe8 document the overload of convex_hull_2 to get rid of an obscure Default_traits() 2012-09-26 07:20:01 +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 5eabc5b78e label of cite must be in the same line 2012-08-21 12:41:52 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +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 17b59d98d2 Move function documentation to the right place 2012-08-20 10:58:30 +00:00
Andreas Fabri d12b1916ca :: is better than () as it then looks as it did with the old tools 2012-08-20 10:39:50 +00:00
Philipp Möller bcb04bb768 Has Model linkification 2012-08-20 10:36:01 +00:00