Clement Jamin
77b9ad86a7
Clarify the doc of CC_safe_handle
2014-02-17 08:05:14 +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
Clement Jamin
5d1eacf16f
rename get_erase_counter => erase_counter
...
And add it to the concept ObjectWithEraseCounter
2013-12-12 07:23:07 +01:00
Clement Jamin
bdd16dccdb
Doc: typos and minor changes following Monique's review.
2013-12-05 17:45:40 +01:00
Clement Jamin
4f27050f17
Added my name
2013-11-26 12:54:55 +01:00
Clement Jamin
1822e1c94f
More detailed doc
2013-11-26 12:54:26 +01:00
Clement Jamin
ec8e949d21
Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
2013-11-21 10:50:55 +01:00
Sébastien Loriot
5f9ab81512
add the function make_sorted_pair
2013-10-18 10:44:54 -07:00
Clement Jamin
91bd59a3e4
Typo
2013-10-16 12:30:53 +02:00
Clement Jamin
6b65ad71da
Changes in the "lock data structure" concept and models
...
The concept is now much more generic (SurjectiveLockDataStructure).
The names have been changed accordingly.
2013-10-16 12:17:56 +02:00
Clement Jamin
85bba6fa44
Minor fixes in the doc.
2013-10-15 10:06:24 +02:00
Clement Jamin
c734677e9f
Doc fixes: "p" => "point" + removed "embedded"
2013-10-15 09:43:28 +02:00
Clement Jamin
f99355ce4e
Doc fix
2013-10-14 18:13:39 +02:00
Clement Jamin
312ccf5398
Doc: replace "embed" by "store"
2013-10-14 18:10:58 +02:00
Clement Jamin
a199ec9332
Rename params
2013-10-14 18:07:50 +02:00
Clement Jamin
e03b9aa762
get_cc_iterator => cc_iterator
2013-10-14 17:50:37 +02:00
Clement Jamin
be66ce4a85
Moved the erase counter example to user doc + add Concurrent CC to user doc
2013-10-09 14:36:54 +02:00
Clement Jamin
72aaf18f49
Minor fixes in documentation
2013-10-01 17:25:44 +02:00
Clement Jamin
5ccd315983
Edited Compact_container doc (erase counter, etc.)
2013-10-01 17:24:22 +02:00
Clement Jamin
2706cbfeff
Compact_container: erase counter strategy is now automatically deduced from T.
...
If the T::increment_erase_counter() function exists, then the erase counter
value will be updated by the Compact_container.
2013-09-30 18:25:41 +02:00
Clement Jamin
41929ed520
Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
...
Conflicts:
Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h
Mesh_3/dont_submit
Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h
Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h
Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h
Triangulation_3/doc/Triangulation_3/PackageDescription.txt
2013-09-25 11:47:43 +02: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
Clement Jamin
801708d322
Doc: added set_bbox
2013-07-25 11:13:20 +02:00
Clement Jamin
aac6819640
Doc: Removed set_bbox from the concept
2013-07-24 19:31:42 +02:00
Clement Jamin
5c17ff1591
Adjustments in the doc following some discussions with Mariette.
2013-07-24 15:06:07 +02:00
Clement Jamin
1eae99f042
Doc: escaped double quotes + use unspecified_type instead of Hidden_type
2013-07-12 15:01:41 +02:00
Clement Jamin
838439b038
Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
...
Conflicts:
Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h
Installation/cmake/modules/FindTBB.cmake
Installation/cmake/modules/UseTBB.cmake
Mesh_3/doc/Mesh_3/CGAL/Mesh_triangulation_3.h
Mesh_3/doc/Mesh_3/Mesh_3.txt
Mesh_3/include/CGAL/Mesh_triangulation_3.h
Surface_mesher/doc/Surface_mesher/Surface_mesher.txt
2013-07-11 09:58:51 +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
Clement Jamin
206b20bc15
Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
2013-07-02 17:37:50 +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
Clement Jamin
7abd1181d8
Doc for template parameter
2013-06-06 18:56:57 +02:00
Clement Jamin
0ec9c67920
Minor doc fix
2013-06-06 16:51:57 +02:00
Clement Jamin
0e51e92656
Introduces a new CC_safe_handle class
...
Helper class which embed a `Compact_container` (or `Concurrent_compact_container`) iterator and is able to know if the pointee has been erased since the creation of the `CC_safe_handle` instance.
2013-06-06 16:49:23 +02:00
Clement Jamin
62ba125fea
More details in the doc
2013-06-05 17:17:50 +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
Clement Jamin
81f9c675c5
P3::x/y/z() functions can now be any model of the concept of RealEmbeddable
2013-05-30 13:38:58 +02:00
Clement Jamin
b1841b35e3
Clarify doc + added is_locked(point)
2013-05-28 15:35:02 +02:00
Clement Jamin
93c7165e97
Smaller tag names + removed "Tag_non_blocking_with_mutexes" from documentation
2013-05-28 15:30:00 +02:00
Clement Jamin
127926aa14
Proof-reading + minor changes
...
Renamed unlock_all_tls_locked_locations => unlock_all_points_locked_by_this_thread
2013-05-28 15:07:20 +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
Clement Jamin
afde58115f
Better phrasing in documentation
2013-04-17 17:34:33 +02:00
Clement Jamin
3a4caaaa1c
Changed the place of the erase counters.
...
Changed Compact_container_strategy_XXX::Uses_erase_counter type + moved the erase counters from Triangulation_ds_xxx_base_3 to Mesh_xxx_base_3.
2013-04-16 15:31: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
9c54e2f39e
Added merge in Concurrent_compact_container documentation
2013-03-12 17:38:09 +01:00
Clement Jamin
33e9ded58f
Documentation: added an "_" before the 3 in SpatialLockDataStructure_3.
2013-03-11 15:34:17 +01:00
Clement Jamin
d1fcea4480
Spatial_grid_lock_data_structure_3 documentation
2013-03-11 15:29:53 +01:00
Clement Jamin
6fbf3a9ec1
Documentation
2013-03-08 18:04:58 +01:00
Clement Jamin
4a90303dc2
Doc for Sequential_tag and Parallel_tag
2013-03-08 11:24:20 +01:00
Clement Jamin
13b7061b0b
Documentation for the Concurrent_compact_container & related classes
...
Modified the documentation of the Compact_container, too: strategy.
2013-03-07 18:10:03 +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
Andreas Fabri
ebe7bfebff
Add assertion failure behaviour and move user manual section
2012-10-02 14:07:25 +00:00
Philipp Möller
a2f6aa1d5e
Minor grouping fixes, linebreaks.
2012-10-02 09:51: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
Philipp Möller
33cd9af6cd
Remove the last remnants of \require and turn them into \requires
2012-10-01 14:56:32 +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
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
Andreas Fabri
6f61e2b2ee
Downsize headings
2012-09-17 14:53:05 +00:00
Philipp Möller
5bed1b15c5
Add basic Surface_mesh_parameterization, grouping and some moves to
...
internal are still missing
2012-09-14 11:15:18 +00:00
Andreas Fabri
513eaf63f1
unlink
2012-09-10 20:18:45 +00:00
Philipp Möller
ba70217acb
document CGAL_ALLOCATOR in the public manual
2012-09-10 15:28:06 +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
76c5ca1899
typo
2012-08-27 19:58:06 +00:00
Andreas Fabri
af87732f6a
Add \anchor of chapters
2012-08-21 10:18:58 +00:00
Andreas Fabri
3dfd7031c2
Remove whitespace
2012-08-20 18:30:46 +00:00
Philipp Möller
d3a9a641de
Refurb package descriptions with a label for the license.
2012-08-20 14:28:36 +00:00
Philipp Möller
49c07b62d6
Fix broken brief descriptions, unlink a word.
2012-08-17 15:31:03 +00:00
Andreas Fabri
c4430ef45e
. instead of ;
2012-08-17 14:06:02 +00:00
Andreas Fabri
9c31449e91
capitalize
2012-08-17 13:56:25 +00:00
Philipp Möller
d5c15dafde
fix double \cite commands
2012-08-17 13:46:35 +00:00
Philipp Möller
f40c0f16f7
update to new layout
2012-08-16 17:08:03 +00:00
Philipp Möller
4a24b439f4
Layouting and package building changes
...
Fiddle with the master doxygen file, improve package overview
building, add a set of packages to the doxyassist XML, fix up
straggling packages that didn't have those changes
2012-08-08 09:21:40 +00:00
Philipp Möller
ebe9072d1d
Testwise STL_Extension + Mesh_2
2012-07-27 18:45:02 +00:00