Sébastien Loriot
9f2eafd06e
extra run of the script to remove tabs and trailing whitespaces
2020-03-26 19:17:02 +01:00
Sébastien Loriot
35b83deffd
Update branch from master after trailing whitespaces and tabs removal
2020-03-26 19:16:25 +01:00
Sébastien Loriot
8bb22d5b2c
extra run of the script to remove tabs and trailing whitespaces
...
right after the merge of the 5.0 release branch
+ manual fix of the files (indentation was changed in the meantime):
* Spatial_sorting/include/CGAL/Multiscale_sort.h
* Spatial_sorting/test/Spatial_sorting/test_multiscale.cpp
2020-03-26 14:26:59 +01:00
Sébastien Loriot
8b153fb495
Merge branch 'cgal/releases/CGAL-5.0-branch'
...
whitespace+tab removal, merged with option -Xignore-space-change
2020-03-26 14:22:32 +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
Mael Rouxel-Labbé
afb5abe61a
Kernel is not a model of ConvexHullTraits_3 (but Extreme_points_... is)
...
K::Traits_xy/xz/yz_3 does not exist
2020-03-24 16:06:03 +01:00
Sébastien Loriot
cccaeaebdb
fix iterator type required
2020-01-15 17:44:01 +01:00
Sebastien Loriot
1406fb22d2
Apply suggestions from code review
...
Co-Authored-By: afabri <andreas.fabri@geometryfactory.com>
2019-04-12 12:37:45 +02:00
Andreas Fabri
6640b3dd3b
typos
2019-04-09 14:15:53 +02:00
Andreas Fabri
4450996725
Add example to the User Manual
2019-04-08 16:13:12 +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
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
Marc Glisse
cc291cda32
Akl/Toussaint algorithm for convex hull uses Orientation_2
2018-10-02 13:54:39 +02:00
Marc Glisse
8caeb6e63a
Akl/Toussaint algorithm for convex hull uses Orientation_2
2018-10-02 13:50:42 +02:00
Mael Rouxel-Labbé
57142bd545
Minor doc change
2017-10-22 23:20:18 +02:00
Sébastien Loriot
c1a243ddf0
add missing requirement in 2D convex hull traits concept + test checking it
2017-05-11 09:53:26 +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
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