Sébastien Loriot
0779373835
extra run of the script to remove tabs and trailing whitespaces
...
right after the merge of 4.14 release branch
+ manual fix on one line in:
* Arrangement_on_surface_2/include/CGAL/IO/Arr_text_formatter.h
* .travis/generate_travis.sh
2020-03-26 14:16:06 +01:00
Sébastien Loriot
0a46621dc6
Merge branch 'cgal/releases/CGAL-4.14-branch'
...
whitespace+tab removal, merged with option -Xignore-all-space
2020-03-26 13:28:46 +01:00
Sébastien Loriot
590612a563
run the script to remove tabs and trailing whitespaces
2020-03-26 13:25:16 +01:00
Sébastien Loriot
fbafb9d06f
fix remaining mismatches and fix bugs
2019-07-10 11:40:45 +02:00
Laurent Rineau
419032d859
Merge pull request #3947 from MaelRL/CGAL-Fix_typos-GF
...
Fix some typos in code/comments/documentation
2019-05-23 08:50:14 +02:00
Mael Rouxel-Labbé
2848158354
Fix typos
2019-05-20 08:54:04 +02:00
Andreas Fabri
ea7ee326b1
CGAL -> \cgal
2019-05-03 12:26:31 +02:00
Sébastien Loriot
59bc453b42
first batch of replacement for level 1 in classified ref man
...
command used:
grep -l "##" */doc/*/PackageDescription.txt | xargs sed -i -E 's/\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\s*$/\\cgalCRPSection{\1}/'
2019-02-14 10:32:39 +01:00
Sébastien Loriot
90ad079eb4
use macro for subsections
...
command used:
grep -l "###" */doc/*/PackageDescription.txt | xargs sed -i -E 's/\#\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\#\s*$/\\cgalCRPSubsection{\1}/
2019-02-14 10:32:00 +01:00
Sébastien Loriot
ea240cfac5
use \PkgXXX instead of \PkgXXXSummary
2018-10-08 10:28:44 +02:00
Sébastien Loriot
a2e8a1c68f
add the suffix Ref to doxygen link to reference
2018-10-08 10:26:56 +02:00
Sébastien Loriot
19adf3b05e
make the doc match struct/class with the implementation
2017-11-17 11:34:55 +01:00
Sébastien Loriot
2507f819b0
document that to_double might not always return the same value
2016-08-24 15:42:22 +02:00
Marc Glisse
64866a966a
typo implicit/explicit
2016-02-15 22:13:00 +01:00
Philipp Möller
0a04a3a48f
Use CGAL_DOC_VERSION
2016-02-11 15:37:54 +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
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
e8632330d8
The result type is not unspecified
2015-10-06 17:35:04 +02:00
Andreas Fabri
0c4902a2dc
fix documentation in Nef_2
2015-03-23 11:03:32 +01:00
Andreas Fabri
4d4859410e
typo
2014-08-26 16:25:29 +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
Michael Hemmer
310ce5affa
backquotes
2014-02-03 14:54:36 +01:00
Michael Hemmer
8f18eb46f9
improve documentation of ImplicitInteroperable
2014-01-30 13:57:14 +01:00
Laurent Rineau
4d721b8969
Fix a typo: RealComparable/RealEmbeddable
2013-12-17 15:39:27 +01:00
Sébastien Loriot
21fe94a3f1
update group name in doc
...
Approved by the release manager
2013-10-04 17:35:31 +02:00
Andreas Fabri
50a4da2992
Put () after function names to increase readability
2013-08-28 15:14:25 +02: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
67a73344f3
fix linking issue
...
fig bug #15486
2013-07-25 13:58:48 +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
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
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
Sébastien Loriot
2ac05c6d95
fix warnings detected by doxygen 1.8.4
2013-05-24 12:49:02 +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
7e59c14580
add a header to classified reference pages using a doxygen macro
2013-03-12 14:33:49 +01:00
Sébastien Loriot
609925675b
add a trailing _ to the namespaces of the concepts in Algebraic Foundations
...
No more warning!
2013-01-24 19:16:40 +01:00
Sébastien Loriot
3b81e2d1a4
fix warnings in algebraic foundations
...
to fix the remaining warnings we need a strategy to disambiguate
the typedef vs. the concept
2013-01-20 12:21:53 +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
ade462dbad
add () to function reference in classified ref man
2013-01-08 17:50:33 +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
42d15a11d0
using uniform markups in classified reference pages
2013-01-04 15:16:40 +01:00
Philipp Möller
0b5021a461
Flatten the modules and integrate the Classified Reference
2012-12-18 22:09:21 +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
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