Mael Rouxel-Labbé
2848158354
Fix typos
2019-05-20 08:54:04 +02:00
Sébastien Loriot
ca755e35a8
Merge pull request #3599 from maxGimeno/Nef_3-Document_Nef_3_to_Polygon_soup-GF
...
Nef_3 : Document convert_nef_polyhedron_to_polygon_soup-GF
2019-04-23 09:52:26 +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
Maxime Gimeno
2feb6c892b
Remove the RandomAccessContainer constraint
2019-01-24 11:57:38 +01:00
Maxime Gimeno
e2f2c63e76
Modifications after review
2019-01-23 11:25:00 +01:00
Maxime Gimeno
18d9e72124
Fix doc and update CHANGES.md
2019-01-22 11:19:38 +01:00
Maxime Gimeno
7a7098d009
Fix doc
2019-01-16 11:23:30 +01:00
Maxime Gimeno
ce72dd895f
First draft of the doc
2019-01-15 12:38:04 +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
Andreas Fabri
f312a3736b
Adress doxygen warning
2018-03-23 15:35:05 +01:00
Andreas Fabri
3580a28a98
Move file from BGL to Nef_3
2018-03-22 16:54:54 +01:00
Maxime Gimeno
a01593e0bb
Unify the links to the Polyhedron demo in the package descriptions.
2017-01-10 14:56:52 +01:00
Sébastien Loriot
cad6cbbcf4
fix doc issues detected by recent doxygen
...
duplicated labels, missing bibtex entry and nested comments
2016-12-28 13:59:45 +01:00
Laurent Rineau
b76e1e021a
Merge pull request #1470 from sloriot/Nef_3-cst_from_FaceGraph
...
Add a Nef_3 constructor from a FaceGraph
2016-10-17 10:03:28 +02:00
Sébastien Loriot
d9413be399
add function convert_nef_polyhedron_to_polygon_mesh and document it
2016-10-05 15:28:12 +02:00
Sébastien Loriot
f1f82785ac
add a constructor from a FaceGraph
...
The first version code is from @afabri
2016-09-21 08:47:06 +02:00
Philipp Möller
0a04a3a48f
Use CGAL_DOC_VERSION
2016-02-11 15:37:54 +01:00
Sébastien Loriot
0877b88370
do not list an example that is in dont_submit
2016-01-22 09:07:52 +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
Sebastien Loriot
2e493f297b
Merge pull request #389 from afabri/CGAL-Qt3-GF
...
Remove Qt3 based demos
2015-10-23 17:08:49 +02:00
Sébastien Loriot
e2af73ca0a
remove Nef_3 widget and remove example path
2015-10-22 09:37:05 +02:00
Andreas Fabri
6056c6b55f
Do not mention Qt3 based demos in the User Manual
2015-10-19 15:35:57 +02:00
Sebastien Loriot
271325c5c3
Merge pull request #325 from sloriot/Nef_3-add_construction_from_points-sloriot
...
add constructor from point, point range and segment
2015-10-05 10:30:58 +02:00
Sébastien Loriot
68c01e9cae
add constructor from point, point range and segment
2015-09-08 10:56:18 +02:00
Sébastien Loriot
32c28ee329
fix doc
2015-09-07 16:07:53 +02: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
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
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
74a1ac055e
remove pdf files from doxygen doc include path
2013-07-25 11:15:18 +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
1d2668d0d8
doc bugfix: figure must be on one line
2013-07-25 10:03:21 +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
d4d9bc212b
replace in the doc \R by \mathbb{R}
...
\R is not a valid latex command
I used: sed -i 's/\\f$\s*\\R/\\f$ \\mathbb{R}/g'
2013-07-10 17:07:43 +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
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
c41bcc8999
remove empty groups
2013-03-14 09:36:56 +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
e991fe72ad
really add last missing classified reference manual pages
2013-03-13 10:57:01 +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
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