Commit Graph

74 Commits

Author SHA1 Message Date
Clement Jamin c062a7ac93 Add doc for operator[] and is_used. 2014-04-18 13:42:45 +02:00
Sébastien Loriot 2629523702 remove make_sorted_pair from the documentation
this function should probably be replaced by std::minmax, so no need
  to introduce a function to deprecate it then
2014-02-18 11:30:24 +01:00
Sébastien Loriot 596e57a1b0 trivial doc polish (avoid long description to be generated) 2014-01-22 15:31:06 +01:00
Sébastien Loriot 3adb58e046 better support of heterogeneous but compatible types 2013-12-17 20:37:19 +01:00
Sébastien Loriot 5f9ab81512 add the function make_sorted_pair 2013-10-18 10:44:54 -07:00
Laurent Rineau fa7588e6e5 Restore correct permissions of files
File created by the Windows port of Emacs, and then commited using the
Cygwin version of Git, have incorrect permissions: they are all executable!
Andreas works using that combination of software.
2013-09-24 11:05:57 +02: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 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
Laurent Rineau e724c1f519 Fix end-of-lines and end-of-files 2013-07-04 11:51:23 +02:00
Clement Jamin 8b0edee1f4 Merge branch 'concurrency_in_cgal-cjamin-old' into concurrency_in_cgal-cjamin 2013-07-03 17:17:34 +02:00
Clement Jamin 31342deb22 Better doc for tags. 2013-07-03 13:01:09 +02:00
Sébastien Loriot e3bdde7054 remove explicit reference to a header file 2013-06-17 09:52:08 +02:00
Sébastien Loriot c09ec2beaa Merge branch 'Kernel-replace_object-pmoeller'
Successfully tested in CGAL-4.3-Ic-59
Approved by the release manager

Conflicts:
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc_tex/Kernel_23_ref/intersection.tex
	Kernel_d/doc/Kernel_d/Kernel_d.txt
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-06-14 14:26:05 +02:00
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Sébastien Loriot b8f31dde5b Merge branch 'STL_Extension-add_operator_dispatch_output-local'
successfully tested in CGAL-4.3-Ic-51
2013-06-05 16:44:14 +02:00
Sébastien Loriot 2997e8ae08 Dispatch_(or_drop_)output_iterator<V,O> now accepts a tuple V put in it ...
...and makes the correct dispatch to the output iterators in O
2013-05-31 17:20:47 +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 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +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 e907f9f444 improve Kernel_23, Kernel_d, STL_extension and Arrangemnt doxygen doc 2013-05-23 10:57:36 +02:00
Sébastien Loriot d6905c61be Merge branch 'Kernel-replace_object-pmoeller-old' into Kernel-replace_object-pmoeller
Conflicts:
	AABB_tree/include/CGAL/AABB_tree.h
	Circular_kernel_2/include/CGAL/Circular_kernel_2/internal_functions_on_line_arc_2.h
	Intersections_3/include/CGAL/Intersections_3/intersection_3_1_impl.h
	Kernel_23/doc/Kernel_23/CGAL/intersections.h
	Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
	STL_Extension/doc/STL_Extension/CGAL/iterator.h
2013-03-14 10:29:31 +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
Clement Jamin 4a90303dc2 Doc for Sequential_tag and Parallel_tag 2013-03-08 11:24:20 +01:00
Sébastien Loriot f0f34d45fa workaround to force the usage of the tr1 implementation of result_of from boost
see http://www.boost.org/doc/libs/1_52_0/libs/utility/utility.htm#result_of
2013-02-04 11:30:28 +01:00
Sébastien Loriot 564960f800 fix mismatching begin/end namespace in doc of iterator 2013-01-23 17:49:58 +01:00
Sébastien Loriot 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +01:00
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +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
Andreas Fabri 9dd07fad37 doc_tex -> doxygen of the STL Extension documentation 2012-12-05 17:15:25 +01:00
Philipp Möller fc1a811b90 Correct the documentation of default 2012-12-03 16:37:00 +01:00
Philipp Möller 93ccbf4465 Remove misleading sentence about array construction
Also improve the make_array documentation to be more concise and
honest.
2012-11-27 15:57:48 +01:00
Philipp Möller 7776eb1631 Pluralize group names. 2012-11-27 15:43:28 +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 0f69c2a512 remove cpp0x namespace from documentation pages 2012-11-14 16:16: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 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
Laurent Rineau 17dc5f2db1 Typo 2012-10-30 17:30:07 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 88a2f0d2db Fix a few warnings 2012-10-09 17:09:25 +00:00
Andreas Fabri c600bd13a5 Add documentation of Join_input_iterator_3 2012-10-09 08:53:12 +00:00
Andreas Fabri 555f3cc729 Add documentation of Join_input_iterator_2 2012-10-09 07:15:43 +00:00
Andreas Fabri 8f7bb695b7 finished including a cleanup in Creators 2012-10-08 20:08:00 +00:00
Andreas Fabri 3b48c61b26 finished including a cleanup in Creators 2012-10-08 19:10:57 +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
Philipp Möller 272a52ee44 Do a global pass over Doxygen warnings/errors. 2012-10-02 15:12:54 +00:00