Commit Graph

55 Commits

Author SHA1 Message Date
Sébastien Loriot 9c2f35ed1a using cgalHeading instead of h3 2013-08-07 10:06:49 +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 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 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Philipp Möller f118e7c6eb Clean up the files we use as examples 2013-05-31 11:40:35 +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 170c619a2d fix places where the <div> added by cgalAdvanced conflicts with other html tags 2013-05-28 09:51:49 +02:00
Sébastien Loriot 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Sébastien Loriot 8d602ed8c2 Merge branch 'triangulation_3-copy_tds-sloriot'
Approved by the release manager

Conflicts:
	Alpha_shapes_3/test/Alpha_shapes_3/copy_tds.h
	Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h

it introduces a more general copy_tds that allows to copy tds with different types of simplices.
2013-04-29 11:09:01 +02:00
Sébastien Loriot e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Sébastien Loriot d34b150e36 using cgalFigureRef instead of ref fig__ 2013-01-24 11:26:16 +01:00
Sébastien Loriot f2d0cc34cd add implementation note in template alias declaration 2013-01-24 11:24:40 +01:00
Sébastien Loriot 6f60be121b fix wrong figure ref 2013-01-24 08:56:09 +01:00
Sébastien Loriot 2444c08a86 move TDS_2::Vertex and TDS_2::Face concepts outside of the class
this allows to define the nested typedefs of the same name.
2013-01-24 08:51:57 +01:00
Sébastien Loriot d4f5f4569b using template alias declaration to inline the rebind classes 2013-01-24 08:37:55 +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 610de5e0ea polish TDS_2 2012-12-28 21:46:44 +01:00
Andreas Fabri 073bc9794f polish TDS_2 2012-12-28 21:28:58 +01:00
Sébastien Loriot d0f1090611 add documentation for tds2 copy_tds 2012-12-19 10:43:48 +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 3914ad9042 fix linking 2012-11-21 10:01:47 +01:00
Sébastien Loriot 37049cab1b incomplete macro 2012-11-19 15:41:43 +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 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Andreas Fabri dc36e89e17 improve doc of rebind; cleanup 2012-10-24 08:31:40 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Laurent Rineau 373e963d2a Fix refs. The label were wrong. 2012-10-04 08:42: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
Andreas Fabri 65185d5049 linking 2012-10-03 07:51:01 +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 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 b153ceb50c Proper documentation for Rebind_* 2012-08-29 08:55:26 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 1e513efc75 fix link 2012-08-27 12:47:22 +00:00
Andreas Fabri 74d761fe19 fix linking in \has Models by backquoting and prefixing with CGAL namespace 2012-08-27 09:09:57 +00:00
Philipp Möller 76aacb1add Change created package names to be the pretty printed version instead
of the readable, short, easy-to-remember SVN version.
2012-08-23 17:00:30 +00:00