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
Sébastien Loriot
716f87d2d7
rename Hidden_type to unspecified_type and update its description
2013-06-13 18:48:58 +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
Andreas Fabri
1675f4da1a
/name -> \name
2013-02-13 16:53:09 +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
Sébastien Loriot
920eb63882
backporting documentation changes of master@9fcc5b57 into doxy-port-pmoeller
...
Conflicts:
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h
Installation/doc_tex/Installation/usage.tex
Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h
Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h
Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h
Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h
Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h
2012-11-23 22:54:31 +01:00
Sébastien Loriot
4554026ed0
backport commit in tex file from master into doxygen
2012-11-23 16:59:19 +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
2155cd6c9b
Polish Geometric Object Generators
2012-11-22 12:32:47 +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
Andreas Fabri
59877a8d52
linking and unlinking
2012-10-30 13:40:03 +00:00
Philipp Möller
f9fd30e2a9
integrate the classified page
2012-10-30 13:28:28 +00:00
Andreas Fabri
3200767818
typo
2012-10-13 12:34:56 +00:00
Andreas Fabri
65b4b91380
finished
2012-10-07 10:03: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
Andreas Fabri
6f61e2b2ee
Downsize headings
2012-09-17 14:53:05 +00:00
Andreas Fabri
2476654eeb
\require -> \requires
2012-08-21 13:01:20 +00:00
Andreas Fabri
115c25c207
\warning, ###Requires, i.e., whitespace
2012-08-20 14:15:10 +00:00
Philipp Möller
6a45864c1a
Throw a set of ported doc files under version control
2012-08-09 16:07:44 +00:00