Sébastien Loriot
590612a563
run the script to remove tabs and trailing whitespaces
2020-03-26 13:25:16 +01: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
2f9408f867
rename link name to match package name
2018-10-08 10:28:55 +02: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
Sébastien Loriot
19adf3b05e
make the doc match struct/class with the implementation
2017-11-17 11:34:55 +01: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
0ad467b321
Use generic example directories
2015-12-10 17:05:53 +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
Maxime Gimeno
7b4267c162
Replacement of cgalRequires
...
-fix for #291
2015-11-23 22:06:06 +01:00
Clement Jamin
82becec870
Add a warning related to multi-threading and CGAL::Timer
2015-10-08 15:23:43 +02:00
Clement Jamin
41929ed520
Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
...
Conflicts:
Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h
Mesh_3/dont_submit
Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h
Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h
Triangulation_3/doc/Triangulation_3/PackageDescription.txt
2013-09-25 11:47:43 +02:00
Sébastien Loriot
04a0d963c8
conversion doc fix: remove variable name in class documentation
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
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
Clement Jamin
a8c8ccd37c
Documentation: Allocator template parameter
2013-07-24 16:30:50 +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
Philipp Möller
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02: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
fd608d0c21
prevent linking and add missing example file
2013-01-31 18:26:44 +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
Andreas Fabri
ccc894c856
polish Miscellany
2012-12-28 22:04:27 +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
008ba8a171
polish Profiling Tools ...
2012-11-22 12:07:12 +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
5ee1081f92
using cgal macros for all figures
2012-11-08 17:17:29 +00:00
Sébastien Loriot
ae159cbdf3
replace markup #, ##, ### by \section, \subsection and \subsubsection
...
(script replacement)
2012-11-06 22:02:15 +00:00
Andreas Fabri
bc1524f6ab
linking unlinking
2012-10-30 13:04:40 +00:00
Philipp Möller
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +00:00
Andreas Fabri
8c221567c6
finished
2012-10-07 08:41:39 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +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
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
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
3b1a496f13
Unlink 'Default'
2012-08-28 14:05:21 +00:00
Andreas Fabri
1db03e28cf
typo
2012-08-27 20:12:59 +00:00
Andreas Fabri
791e790fa9
\require -> \requires
2012-08-21 13:36:14 +00:00
Andreas Fabri
3fb4aa8cc5
I> -> *
2012-08-21 13:34:25 +00:00