songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
100,690 Commits 3 Branches 156 Tags 959 MiB
Commit Graph

176 Commits

Author SHA1 Message Date
Andreas Fabri c775be2506 typos in the user manual 2014-12-08 16:57:44 +01:00
m.overtheil 53aecd416f Deleted double indirection 2014-12-08 12:10:52 +01:00
m.overtheil 76cb978a13 Added Figures,benchmark and implementation History 2014-12-08 09:38:20 +01:00
Andreas Fabri df2a957fbe add illustration gfor benchmark 2014-12-05 16:28:34 +01:00
m.overtheil 7fe5f7c9ae Fixed most of the old benchmarks 2014-12-05 14:36:46 +01:00
m.overtheil 1e6b69ccd9 Added tparam to doc 2014-12-04 15:58:03 +01:00
Andreas Fabri 9c7ab7568c typos and partial switching to \tparam 2014-12-04 10:07:52 +01:00
Andreas Fabri 9650d226a1 typos and partial switching to \tparam 2014-12-04 09:52:01 +01:00
m.overtheil 88dca7f9af Typo 2014-12-03 15:09:28 +01:00
m.overtheil 17068ae8b4 Documentation 2014-12-03 14:55:20 +01:00
m.overtheil d598526bfe added dimension template argument to doc 2014-11-04 15:59:56 +01:00
Sébastien Loriot 7247e971fc fix wrong documented traits 2014-09-12 13:23:46 +02:00
Sébastien Loriot e97efd228f prevent linking 2014-07-15 14:25:21 +02:00
Eric Berberich dee9fc8235 Merge branch 'Snap_rounding_2-kd_tree_replacement-wkhan-old' into Snap_rounding_2-kd_tree_replacement-wkhan 
Conflicts:
	Installation/changes.html
 2014-04-09 10:11:35 +02:00
Eric Berberich 9d8a02aa46 rephrased documentation for capacity in Kd_tree 2014-03-28 14:50:18 +01:00
Waqar Khan 98e6007dd3 * Added the capacity() function to the Kd_tree.h and also added its documentation 
* Added a test that checks the reserve() and capacity() function for Kd_tree
 2014-03-26 18:02:04 +01:00
Eric Berberich 398613ec71 rephrased documentation of "reserve" to proposal of Sebastien 2014-03-10 12:12:59 +01:00
Waqar Khan 1c355ef42a 1. "Snap_rounding_traits_2.h" "Snap_rounding_kd_2.h" "Kd_tree.h" "snap_rounding_data.cpp", Changed the File header signature to match the templated signatures. 
2. Made the required changes in the concepts i.e. in "Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h"
 3. Added documentation for the reserve() method of Kd_tree
 4. Deleted the un maintained olk kd_tree package
 2014-03-07 16:13:44 +01:00
Sébastien Loriot 7451a3a238 fix incorrect name 2014-02-21 15:46:56 +01:00
Sébastien Loriot 0b3c2ae383 fix a documentation bug and add static assertions 
the class Search_traits_adapter must use only Lvalue_property_map since
  it uses the Cartesian_const_iterator from the base class which is usually
  simply the pointer on the double in the point. If the point returned by
  the property map is a temporaty, the iterator is invalid and its behavior
  is undefined
 2014-02-21 15:36:40 +01: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 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +02:00
Sébastien Loriot d4d9bc212b replace in the doc \R by \mathbb{R} 
\R is not a valid latex command
I used: sed -i 's/\\f$\s*\\R/\\f$ \\mathbb{R}/g'
 2013-07-10 17:07:43 +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 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Sébastien Loriot 7412cdb650 add all property maps concepts to ease linking to them. Update pages using them 2013-03-14 16:59:27 +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
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Andreas Fabri 42f6145233 Avoids advanced brief descriptions 2013-01-08 14:53:44 +01:00
Sébastien Loriot 318c280932 less linking 2013-01-07 19:26:50 +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
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 12f13a686c backport commit in tex file from master into doxygen 2012-11-23 19:08:44 +01:00
Andreas Fabri 5f7e44a277 small fixes 2012-11-23 14:30:41 +01:00
Andreas Fabri 72f48d7e8d Polish dD Spatial Searching 2012-11-23 13:59:31 +01:00
Sébastien Loriot bfca42081d add missing backquotes in cgalModels 2012-11-23 09:55:55 +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 ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection 
(script replacement)
 2012-11-06 22:02:15 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 376ed06365 remove todo 2012-10-05 07:45:45 +00:00
Andreas Fabri 237af122b3 finished 2012-10-05 07:42:09 +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
Philipp Möller c9fdbf3edb Add an anchor to each level one heading, so we get a nice tree in the 
user manuals.
 2012-10-02 11:53:01 +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
Philipp Möller b64ba48134 The changes to move the package overview labels into the 
PackageDescription.
 2012-09-25 17:17:49 +00:00
Andreas Fabri 67a9587167 Add typedef keyword 2012-09-21 13:30:32 +00:00
Philipp Möller e54098fb57 Throw out left over Classified files and move their content if 
necessary.
 2012-09-20 16:29:19 +00:00
Philipp Möller 1954eff3d6 * build normalized mainpage anchors 
* better naming for Pkg commands
* User and Reference Manual links from the PackageOverview
 2012-09-20 15:30:03 +00:00
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller 864aebe2e5 Merge next. 
This commit also updates the respective mock-headers when the
corresponding .tex documentation has changed. This has been the case for:

AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABB_traits.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_features.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_no_features.tex
Number_types/doc_tex/NumberTypeSupport_ref/Interval_nt.tex
Number_types/doc_tex/NumberTypeSupport_ref/Lazy_exact_nt.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_2.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_3.tex
Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex
 2012-09-12 14:14:22 +00:00
Andreas Fabri 4237508ae2 whitespace 2012-09-03 14:26:41 +00:00
Andreas Fabri 028726c79f typos 2012-09-03 13:40:56 +00:00
Andreas Fabri e774b01b9a unlink 2012-09-03 13:17:40 +00:00
Philipp Möller 2d8931167f autoexamples 2012-08-29 16:20:55 +00:00
Philipp Möller 5a0a5403c4 Enable autotoc on mainpages 2012-08-29 15:45:17 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 3b1a496f13 Unlink 'Default' 2012-08-28 14:05:21 +00:00
Andreas Fabri bbd2973905 fix as r71706 2012-08-28 08:59:37 +00:00
Andreas Fabri 6343443d92 unlink Cartesian 2012-08-27 13:09:56 +00:00
Andreas Fabri 9375a5e04a fix linking in \hasModel by backquoting 2012-08-27 13:08:43 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +00:00
Philipp Möller d3a9a641de Refurb package descriptions with a label for the license. 2012-08-20 14:28:36 +00:00
Andreas Fabri 33c414cc88 no blank between k and d in k-d tree 2012-08-17 12:39:28 +00:00
Philipp Möller 6a45864c1a Throw a set of ported doc files under version control 2012-08-09 16:07:44 +00:00