Sébastien Loriot
0fa2cacb60
remove doc_tex documentation (including developer manual) and old manual tools
2013-12-03 17:27:02 +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
Laurent Rineau
bc03aaf30b
Put doc/ in the global dont_submit file
2013-08-20 10:57:03 +02:00
Sébastien Loriot
4d9ab18fa0
add missing namespace
2013-08-07 17:36:06 +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
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
Philipp Möller
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
Sébastien Loriot
e2e19cfbb0
rename Stream_support doc directory from IOstream to Stream_support
2013-05-29 14:16:05 +02:00
Sébastien Loriot
a007839e41
according to the doxygen doc a \anchor must be placed on a \page or \mainpage
...
create a group for stream operator so that we can refer to them
2013-05-29 13:37:08 +02:00
Laurent Rineau
008ccc5b48
Add missing #include <cassert>
2013-04-25 11:20:36 +02:00
Laurent Rineau
b6ffa7c425
Merge branch 'CGAL-fix_warnings-GF'
...
That branch was successfully tested in CGAL-4.2-Ic-205.
2013-03-27 12:23:31 +01:00
Sébastien Loriot
9fcf46e11a
replace CGAL_[kernel/qpe/triangulation/]_assertion by assert in tests
...
this should be the case, following our guidelines.
using:
find */test/* -name '*.[hc]*' | xargs sed -i 's/CGAL_assertion/assert/g'
2013-03-21 10:50:55 +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
Laurent Rineau
26a7e70785
New license.txt files (eol changes)
...
The new version 2.13.0 of licensecheck has changed the spaces at eol.
2013-02-19 16:46:39 +01:00
Sébastien Loriot
ebd2f15dd1
follow up of 601fd3b9: adding missing () in see also for functions
2013-01-09 19:48:43 +01:00
Sébastien Loriot
6e63d3cfa8
adding missing () in see also for functions
2013-01-09 19:48:42 +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
Sébastien Loriot
9576be3c3b
add doc in dont_submit
2012-11-27 08:42:02 +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
d14037bf00
polish IO Stream
2012-11-22 11:54:02 +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
Andreas Fabri
9dd1045208
linking unlinking
2012-10-30 13:07:40 +00:00
Philipp Möller
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +00:00
Andreas Fabri
b03767cad4
rename tag to avoid clash
2012-10-11 13:47:34 +00:00
Philipp Möller
88a2f0d2db
Fix a few warnings
2012-10-09 17:09:25 +00:00
Andreas Fabri
d539359b46
finished
2012-10-05 14:22:50 +00:00
Philipp Möller
9de8bc34da
Fix links to operators
2012-10-05 14:19:59 +00:00
Philipp Möller
2636b7a407
Kill nav-sync, fix the ### bug.
2012-10-04 15:07:33 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +00:00
Philipp Möller
bdf6f2e47d
Small fixes for some awkward back-ticks and correctly link in Polygon.
2012-10-03 13:19:39 +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
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
0aa7cd1c3b
Global heading reduction. Rename some Parameter section to Template
...
Parameters. Fix dependencies.
2012-09-21 09:42:24 +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
Andreas Fabri
6f61e2b2ee
Downsize headings
2012-09-17 14:53:05 +00:00
Andreas Fabri
266056a970
Add \autotoc
2012-09-15 18:18:56 +00:00
Andreas Fabri
e764d966d6
de-math
2012-09-14 16:37:08 +00:00
Philipp Möller
fa9c95ed7e
Add Stream_support doc
2012-09-13 18:19:18 +00:00
Laurent Rineau
a04891ff93
WARNFIX: fix some warnings triggered by -Wconversion on g++
2012-08-09 16:06:54 +00:00
Philipp Möller
1ffa0e6a2a
Moved over a bit from the description in iostream.
2012-06-22 14:45:34 +00:00
Philipp Möller
88963525b6
Merged iostream into Stream_support
2012-06-22 14:43:58 +00:00
Laurent Rineau
52d230565c
Remove files added but not used
2012-04-18 13:43:24 +00:00
Andreas Fabri
9d86cb2ea9
Fix for Windows 'min/max' bug
2012-01-18 10:10:14 +00:00