Commit Graph

71 Commits

Author SHA1 Message Date
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Sébastien Loriot 72863bfe44 fix doxygen warnings 2016-02-04 21:19:36 +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 c5d3cdb20e Remove unnecessary Doxyfile.in statements
It is not necessary to specify the IMAGE_PATH or EXAMPLE_PATH here. Add
the images, if necessary.
2015-12-10 17:04:51 +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
Andreas Fabri 6056c6b55f Do not mention Qt3 based demos in the User Manual 2015-10-19 15:35:57 +02:00
Sébastien Loriot 4787bda61f remove documented widget based on Qt3 2015-10-05 15:20:06 +02:00
Sébastien Loriot cdfc7f1c31 Merge branch 'old/CGAL-split_packages-GF' into CGAL-split_packages-GF 2015-09-23 10:08:41 +02:00
Sébastien Loriot 970105e31c fix qt dependency text 2015-09-10 15:04:12 +02:00
Sébastien Loriot 8601e5ef0f move Kinetic examples 2015-08-26 17:27:09 +02:00
Andreas Fabri 67d72675fe split packages 2015-08-17 23:46:59 +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
Laurent Rineau 38e5dc102d Remove execution permissions 2013-11-13 14:05:43 +01:00
Sébastien Loriot 9c2f35ed1a using cgalHeading instead of h3 2013-08-07 10:06:49 +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 e3bdde7054 remove explicit reference to a header file 2013-06-17 09:52:08 +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 890b02ead6 add last missing classified reference manual 2013-03-12 18:46:37 +01:00
Sébastien Loriot ce3420d639 document missing swap function in KDS 2013-02-13 14:23:32 +01:00
Sébastien Loriot 4f519a35b8 various documentation fixes
I renamed the concept file Kernel.h because it was conflicting with Kernel.h
from the Kernel (present in the tag file)
Fix linking
2013-01-31 19:38:22 +01:00
Sébastien Loriot 844501748d fix warnings in KDS doxygen doc 2013-01-20 12:47:34 +01:00
Andreas Fabri e1b5921470 first pass over KDS 2013-01-09 15:14:37 +01:00
Sébastien Loriot 91745e7ccf fix linking 2013-01-07 20:43:56 +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 7e095c7a7a Merge branch 'Documentation-flat-ref-manual-pmoeller' 2013-01-04 15:19:57 +01:00
Sébastien Loriot 42d15a11d0 using uniform markups in classified reference pages 2013-01-04 15:16:40 +01:00
Sébastien Loriot 468f1a7d2c add missing inline example 2013-01-04 11:45:49 +01:00
Sébastien Loriot 734ace488e prevent linking 2013-01-04 11:40:23 +01:00
Sébastien Loriot 9631c3444c name link to chapters 2013-01-02 23:00:56 +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 4ec9529581 Merge branch 'doxy-port-pmoeller'
Conflicts:
	.gitattributes
	Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h
	Surface_reconstruction_points_3/include/CGAL/Reconstruction_triangulation_3.h
	Surface_reconstruction_points_3/include/CGAL/k_nearest_neighbor.h
2012-11-27 10:05:41 +01:00
Sébastien Loriot 834dd92263 special cases for replacing \cgalModels ::FOO by \cgalModels `FOO` 2012-11-23 09:42: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
Sébastien Loriot 8d741d504d remove % in section name 2012-11-14 16:10:15 +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 1125f1afb0 fit the page 2012-11-08 18:41:14 +00: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