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
bc03aaf30b
Put doc/ in the global dont_submit file
2013-08-20 10:57:03 +02:00
9c2f35ed1a
using cgalHeading instead of h3
2013-08-07 10:06:49 +02:00
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
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
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
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
74a1ac055e
remove pdf files from doxygen doc include path
2013-07-25 11:15:18 +02:00
519b301130
remove gif files from doxygen doc include path
2013-07-25 11:14:16 +02:00
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
716f87d2d7
rename Hidden_type to unspecified_type and update its description
2013-06-13 18:48:58 +02:00
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
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
008ccc5b48
Add missing #include <cassert>
2013-04-25 11:20:36 +02:00
b6ffa7c425
Merge branch 'CGAL-fix_warnings-GF'
...
That branch was successfully tested in CGAL-4.2-Ic-205.
2013-03-27 12:23:31 +01:00
9fcf46e11a
replace CGAL_[kernel/qpe/triangulation/]_assertion by assert in tests
...
this should be the case, following our guidelines.
using:
find */test/* -name '*.[hc]*' | xargs sed -i 's/CGAL_assertion/assert/g'
2013-03-21 10:50:55 +01:00
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
7e59c14580
add a header to classified reference pages using a doxygen macro
2013-03-12 14:33:49 +01:00
d69f849cba
Merge branch 'master' of ssh://scm.cgal.org/var/git/cgal
2013-03-05 20:26:49 +01:00
2d8da664a3
Merge branch 'CGAL-fix_warnings-gdamiand'
...
Conflicts:
.gitignore
Skin_surface_3/examples/Skin_surface_3/CMakeLists.txt
2013-02-22 13:02:37 +01:00
26a7e70785
New license.txt files (eol changes)
...
The new version 2.13.0 of licensecheck has changed the spaces at eol.
2013-02-19 16:46:39 +01:00
1675f4da1a
/name -> \name
2013-02-13 16:53:09 +01:00
a73324b1e4
Removed srand, as I don't see where it is used.
...
Make remaining ugly code, even a bit uglier to avoid a warning.
2013-02-13 16:49:55 +01:00
ebd2f15dd1
follow up of 601fd3b9: adding missing () in see also for functions
2013-01-09 19:48:43 +01:00
6e63d3cfa8
adding missing () in see also for functions
2013-01-09 19:48:42 +01:00
e261f3b17b
add missing examples
2013-01-09 19:48:42 +01:00
5ec28b1cf4
replacing the usage of section in user man by \cgalHeading macro call
2013-01-07 18:04:37 +01:00
5f3c8826d1
h2 is the first header in classified reference manuals
2013-01-07 09:00:48 +01:00
7e095c7a7a
Merge branch 'Documentation-flat-ref-manual-pmoeller'
2013-01-04 15:19:57 +01:00
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
82b2ebc865
apply the cpp0x namespace renaming in all files
2012-12-19 11:33:17 +01:00
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
9576be3c3b
add doc in dont_submit
2012-11-27 08:42:02 +01:00
9347a5d812
remove empty lines at end of dont_submit files
2012-11-27 08:35:33 +01:00
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
6cc7d66415
Revert "Replace tex-style quotes with quotes that you would expect, as there"
...
This reverts commit e65a8028ea
2012-11-23 18:08:13 +01:00
7cd0e93fa9
Revert "Merge the changes to ccPrecond and ccPostcond that have been in"
...
This reverts commit b529971917
2012-11-23 18:04:33 +01:00
4554026ed0
backport commit in tex file from master into doxygen
2012-11-23 16:59:19 +01:00
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
2155cd6c9b
Polish Geometric Object Generators
2012-11-22 12:32:47 +01:00
625f9f6cd7
after git merge remotes/origin/hot-fixes-for-Git
2012-11-20 13:02:17 +01:00
0f69c2a512
remove cpp0x namespace from documentation pages
2012-11-14 16:16:15 +01:00
8d741d504d
remove % in section name
2012-11-14 16:10:15 +01:00
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
5ee1081f92
using cgal macros for all figures
2012-11-08 17:17:29 +00:00
ae159cbdf3
replace markup #, ##, ### by \section, \subsection and \subsubsection
...
(script replacement)
2012-11-06 22:02:15 +00:00
6abaad0be3
No need for :: as prefix in backquotes
2012-10-31 20:52:33 +00:00
59877a8d52
linking and unlinking
2012-10-30 13:40:03 +00:00
f9fd30e2a9
integrate the classified page
2012-10-30 13:28:28 +00:00
31e9eadf8b
Fix all PackageDescriptions to a newer layout
2012-10-19 15:52:31 +00:00
Sébastien Loriot
Laurent Rineau
Ross Hemsley
Philipp Möller
Alexandros Konstantinakis-Karmis
Andreas Fabri
Sébastien Loriot
Philipp Möller