Commit Graph

664 Commits

Author SHA1 Message Date
Laurent Rineau afa62cbb40 First draft of a documentation for Polyhedral_complex_mesh_domain_3 2017-07-07 10:15:10 +02:00
Mael Rouxel-Labbé 5ef4ed6083 Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle
Based on master
2017-07-03 16:12:14 +02:00
Mael Rouxel-Labbé a68423f4c8 Adapted the documentation to the new concept RegTrCellBaseWithWeightedCircumcenter
- MeshCellBase_3 loses "invalidate_circumcenter" and refines the new concept
- Reg_tr_cell_base_with_weighted_circumcenter_3 is a model of the new concept
2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 03e646679f MeshVertexBase_3 must refine RegularTriangulationVertexBase_3
and not TriangulationVertexBase_3
2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 7e92f1ae9e Cosmetic changes to MeshCellBase_3 2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 9c044c00eb Fixed the concept MeshCellBase_3
The surface center is not of type Tr::Point, but Tr::Bare_point.
Added to changes.html
2017-06-28 10:16:23 +02:00
Mael Rouxel-Labbé 1dcc8b1fc5 Fixed Mesh_3's criteria concepts 2017-06-19 17:59:36 +02:00
Mael Rouxel-Labbé 6bb260c954 Document Mesh_3 criteria change (see dd5cd9a) 2017-06-19 15:55:15 +02:00
Andreas Fabri ecad0cd4ea resize image 2017-06-06 15:36:40 +02:00
Andreas Fabri df25680911 Improve doc 2017-06-06 13:54:24 +02:00
Laurent Rineau b537432884 fix permissions 2017-06-02 17:02:38 +02:00
Mael Rouxel-Labbé 75e9d0dbc1 Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov
Based on Periodic_3_Regular_triangulatio...
  @ e933ec4459c1ea00e9f43098807da7122b099425
2017-06-02 16:42:23 +02:00
Mael Rouxel-Labbé 5df733c3af Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle
Based on Kernel_Weighted_point_without...
  @ 3e43409d01
2017-06-02 16:28:17 +02:00
Mael Rouxel-Labbé f614b7ae3e Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle
Based on Kernel_Weighted_point_without...
  @ 3e43409d01
2017-06-02 16:28:17 +02:00
Mael Rouxel-Labbé d8dfeec94b Adapted the documentation to the new concept RegTrCellBaseWithWeightedCircumcenter
- MeshCellBase_3 loses "invalidate_circumcenter" and refines the new concept
- Reg_tr_cell_base_with_weighted_circumcenter_3 is a model of the new concept
2017-06-01 11:23:04 +02:00
Andreas Fabri 1c2a21f743 Add an example for a polyhedral domain with a surface inside 2017-05-31 10:25:44 +02:00
Mael Rouxel-Labbé b58cfe0895 Merge branch 'Periodic_3_mesh_3-Feature-MBogdanov-old' into Periodic_3_mesh_3-Feature-MBogdanov
Based on the P3RT3 branch
2017-05-29 10:15:19 +02:00
Mael Rouxel-Labbé 5354134469 Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle 2017-05-24 12:18:49 +02:00
Mael Rouxel-Labbé 4018368e11 Merge branch 'Periodic_3_Regular_triangulation_3-APelle-old' into Periodic_3_Regular_triangulation_3-APelle 2017-05-24 12:18:49 +02:00
Mael Rouxel-Labbé 971d916f5d MeshVertexBase_3 must refine RegularTriangulationVertexBase_3
and not TriangulationVertexBase_3
2017-05-22 11:27:02 +02:00
Mael Rouxel-Labbé 8b6a91e6bb Cosmetic changes to MeshCellBase_3 2017-05-22 11:27:02 +02:00
Mael Rouxel-Labbé 8a1fac230e Fixed the concept MeshCellBase_3
The surface center is not of type Tr::Point, but Tr::Bare_point.
Added to changes.html
2017-05-22 11:27:02 +02:00
Mael Rouxel-Labbé a66474b5fd Documented the use of the Robust_weig... traits in Mesh_triangulation_3 2017-05-22 11:15:50 +02:00
Mael Rouxel-Labbé 4d98a0639f Documented the use of the Robust_weig... traits in Mesh_triangulation_3 2017-05-22 11:15:50 +02:00
Mael Rouxel-Labbé 8a00196484 Added P3M3 reference manual 2017-04-04 14:56:48 +02:00
Sebastien Loriot cce6932af9 Merge pull request #1947 from janetournois/Mesh_3-add_lipschitz_sizing-example-jtournois
Mesh_3 - add an example for `Lipschitz_sizing`
2017-03-16 11:03:33 +01:00
Jane Tournois 9d6d548bb0 doc fix : add ref to Lipschitz example 2017-03-07 17:43:25 +01:00
Jane Tournois bb85486119 improve text 2017-03-02 16:04:37 +01:00
Jane Tournois 8ae1c32d53 add figure for lipschitz sizing 2017-03-02 15:59:11 +01:00
Jane Tournois 2da9e461c5 WIP doc Lipschitz example 2017-03-02 14:12:42 +01:00
Sébastien Loriot b67bfce41f add a link to the example 2017-03-01 09:56:11 +01:00
Andreas Fabri 09d7723f23 Refer to the example that allows to read DICOM files 2017-02-28 11:42:24 +01:00
Laurent Rineau 038f24925e Merge pull request #1211 from lrineau/Mesh_3-hybrid_mesh_domain-GF
Create an example with hybrid mesh domain
2017-01-12 11:09:58 +01:00
Maxime Gimeno a01593e0bb Unify the links to the Polyhedron demo in the package descriptions. 2017-01-10 14:56:52 +01:00
Jane Tournois 1a724986a7 add figs 2017-01-09 08:20:35 +01:00
Jane Tournois 57d86c6e7f add some doc for hybrid mesh domain example 2017-01-06 16:10:45 +01:00
Andreas Fabri 16d0f63a4d Move the documentation of the deprecated function to the end 2016-11-03 15:01:23 +01:00
Andreas Fabri be1b2f9231 Do not construct from a string 2016-11-01 11:19:43 +01:00
Laurent Rineau 6960d53e74 Remove the Mesh_3 demo
That demo has been replaced by plugins in the Polyhedron_3 demo.
2016-09-29 10:23:17 +02:00
Laurent Rineau 611c5cd721 Merge pull request #1303 from janetournois/Mesh_3-fix_criteria_doc-jtournois
Mesh 3 - doc fix for facet_distance criterion
2016-07-27 16:13:12 +02:00
Jane Tournois 4efb8994ea doc : the documentation was displaying the name of the anchor
instead of the name of the section
2016-07-26 11:51:25 +02:00
Jane Tournois 90fc548186 fix the doc of facet_distance 2016-07-26 11:51:24 +02:00
Jane Tournois b20f934e13 use \param and improve the display 2016-07-26 11:51:23 +02:00
Laurent Rineau 2153e65383 Fix a typo in doc: remove extra "`" 2016-07-07 15:31:42 +02:00
Laurent Rineau b95a960058 Minor modifications
... after feedback from @afabri.
2016-06-16 15:30:08 +02:00
Jane Tournois b322f53e85 fix a few typos 2016-06-16 12:17:13 +02:00
Laurent Rineau cc49cd4561 Move the subsubsection to the right subsection 2016-06-15 18:10:15 +02:00
Laurent Rineau 087138274c Add the pictures 2016-06-15 18:10:15 +02:00
Laurent Rineau 07b2acdd3c Add the documentation 2016-06-15 18:10:15 +02:00
Laurent Rineau f87c007402 Add pictures 2016-06-15 18:10:14 +02:00
Sebastien Loriot cf15f57a50 Merge pull request #1097 from lrineau/Mesh_3-improve_polylines_to_protect-GF
Mesh 3: add an example that protects features of a 3D image
2016-05-31 16:00:58 +02:00
Sébastien Loriot 82d613f963 remove height parameter to avoid bad looking result 2016-05-31 15:58:43 +02:00
Sébastien Loriot 40ff09bd43 Merge pull request #303 from lrineau/Mesh_3-add_remesh_polyhedral_surface-GF
Add an example that remeshes a polyhedral surface
2016-05-31 15:43:05 +02:00
Laurent Rineau 33c232ea95 Update the documentation
I have taken into account remarks from Andreas Fabri and Jane Tournois.
2016-05-26 17:02:48 +02:00
Jane Tournois 46859cfca4 doc : add details 2016-05-26 16:14:01 +02:00
Jane Tournois 7c28ed079d user manual : put the 2 polyhedral examples into the same subsection 2016-05-26 12:18:32 +02:00
Jane Tournois cc34901694 document boundaries in Polyhedral_mesh_domain_with_features_3 2016-05-26 12:13:02 +02:00
Jane Tournois 9990bfcb52 fix typos 2016-05-26 10:55:17 +02:00
Laurent Rineau f969496072 Add the pictures in the documentation. 2016-05-25 17:41:39 +02:00
Laurent Rineau d6da4ce5b4 Add the subsubsection in the documentation 2016-05-25 17:19:12 +02:00
Andreas Fabri 224ad74712 Mention CGAL::Default in the ref man pages of Mesh_triangulation_3 2016-03-23 12:21:45 +01:00
Andreas Fabri 7f3d561fee Add protection of border edges 2016-02-22 13:44:04 +01:00
Andreas Fabri 6e7c567cdb Add a figure of the remeshing 2016-02-17 12:20:11 +01:00
Andreas Fabri 23bbe6e093 Add the example in the User Manual 2016-02-17 10:45:52 +01:00
Laurent Rineau def3952e0e Merge pull request #767 from bo0ts/Documentation-no_internal_in_title-pmoeller
Remove internal release number from documentation title
2016-02-11 15:42:40 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Jane Tournois 5e13218ebe fix documentation about detection of sharp features for Mesh_3
see issue #747
2016-02-08 16:27:38 +01:00
Sébastien Loriot 06c304c614 fix doc warnings spotted by doxygen 1.8.11
Tested locally
2016-02-04 22:23:48 +01:00
Sébastien Loriot e5d5f4f2bd add missing example 2016-01-22 09:05:27 +01:00
Jane Tournois 845fc80bef improve documentation of Gray_image_mesh_domain_3 2016-01-21 11:59:38 +01:00
Andreas Fabri 8d0d9e00c5 Emphasize with * and not with backquote; backquote function calls 2016-01-08 17:23:44 +01:00
Sébastien Loriot e64ae35a6e Merge pull request #542 from bo0ts/Documentation-release_build2-pmoeller
Allow to build the documentation in a release
2016-01-07 09:21:46 +01:00
Sébastien Loriot e354ba6d37 remove examples that are in dont_submit 2016-01-07 09:19:06 +01:00
Sébastien Loriot dd8f33adc5 Merge pull request #559 from lrineau/Mesh_3-remove_estimated_bbox-lrineau
Add bbox() to MeshDomain_3
2016-01-06 14:35:01 +01:00
Laurent Rineau 7a22788e73 Fix typos
- *a* bounding box
- return*s*
2016-01-04 13:06:25 +01:00
Sébastien Loriot dd955cef30 Merge pull-request #483 from 'janetournois/Mesh_3-gray_level_image_oracle-lrineau'
Mesh 3 : add gray level image oracle
2015-12-18 16:46:46 +01:00
Philipp Möller 71b4e9c515 Use CGAL_FULL_VERSION in all Doxyfile.in 2015-12-17 16:33:28 +01:00
Laurent Rineau 2af8d42ed3 Add bbox() to MeshDomain_3 2015-12-16 11:52:52 +01:00
Philipp Möller 3d772e9d9d Generic reference to the doc dir 2015-12-10 17:05:51 +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
Sébastien Loriot e58f9a3537 document the need to link with ImageIO 2015-11-23 23:32:54 +01:00
Jane Tournois 3f308a48af Merge branch 'Mesh_3-gray_level_image_oracle-lrineau-old' into Mesh_3-gray_level_image_oracle-lrineau 2015-11-17 11:16:53 +01:00
Jane Tournois 9dc31b52e4 add documentation of parameters 2015-10-13 15:38:35 +02:00
Jane Tournois 761b69c5c5 add documentation for Gray_image_mesh_domain_3 2015-10-13 15:14:18 +02:00
Clement Jamin 77e6772aa7 Use Real_timer in Mesh_3 since the algorithms might be parallel
And update the doc accordingly
2015-10-08 15:26:50 +02:00
Sébastien Loriot ce8806b19b Merge remote-tracking branch 'cgal-dev/CGAL-Qt_no_keywords-GF' into Mesh_2-add_optimizers-GF
Conflicts:
	GraphicsView/demo/Triangulation_2/Constrained_Delaunay_triangulation_2.cpp
2015-05-19 09:07:08 +02:00
Sébastien Loriot 7cabb0c508 Merge branch 'rebase/Mesh_2-add_optimizers-GF-old' into rebase/Mesh_2-add_optimizers-GF
Conflicts:
	GraphicsView/demo/Triangulation_2/Constrained_Delaunay_triangulation_2.cpp
	GraphicsView/demo/Triangulation_2/Constrained_Delaunay_triangulation_2.ui
	Triangulation_2/include/CGAL/Constrained_Delaunay_triangulation_2.h
2015-05-19 09:01:20 +02:00
Jane Tournois 83c415bca9 move Mesh_optimization_return_code from Mesh_3 to Mesh_2
Mesh_3 already depends on Mesh_2,
but not the other way around
2015-05-19 08:54:36 +02:00
Andreas Fabri 52382276a8 Escape the word Index with '%' 2015-04-23 12:04:35 +02:00
Laurent Rineau 908d608072 Merge branch 'releases/CGAL-4.5-branch'
Conflicts:
	Installation/changes.html
2014-10-20 14:46:36 +02:00
Sébastien Loriot 866ea60192 typos 2014-09-30 11:14:50 +02:00
Sébastien Loriot 81d63b133e typos 2014-09-30 11:14:50 +02:00
Sébastien Loriot 024bd2724f add output_facets_in_complex_to_off and update test and demo 2014-09-24 12:05:02 +02:00
Sébastien Loriot 684104c032 add 2 overloads of output_boundary_of_c3t3_to_off in the C3T3 class
also update the demo plugin to use one of them
2014-09-24 08:26:18 +02:00
Aymeric PELLE 3d37d6abe6 Add two examples for meshing multi domains. Fix some mistakes in the doc. 2014-09-03 16:55:10 +02:00
Clement Jamin e3abf7fc40 Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin 2014-07-01 10:38:14 +02:00
Clement Jamin 50fed20337 Update todo 2014-06-30 15:13:01 +02:00
Clement Jamin f3c00442fd Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin 2014-05-14 19:05:40 +02:00
Laurent Rineau cd94d98168 Revert "Revert an incorrect push I did"
This reverts commit 33cb60cc29.
2014-05-07 15:24:25 +02:00
Laurent Rineau 33cb60cc29 Revert an incorrect push I did 2014-05-07 15:18:53 +02:00
Laurent Rineau 68c367a2df Revert "Revert "Merge branch 'Periodic_3_mesh_3-Extended_mesh_3-MBogdanov'""
This reverts commit 2e58135751.
2014-05-07 13:56:20 +02:00
Laurent Rineau 2e58135751 Revert "Merge branch 'Periodic_3_mesh_3-Extended_mesh_3-MBogdanov'"
This reverts commit 2ec2fb3c8e, reversing
changes made to 2ed7784521.
2014-04-16 17:37:04 +02:00
Aymeric PELLE 2ec2fb3c8e Merge branch 'Periodic_3_mesh_3-Extended_mesh_3-MBogdanov'
- This small feature adds a method to locate point with inexact predicates in
  Periodic_3_triangulation_3.
  (cf. https://cgal.geometryfactory.com/CGAL/Members/wiki/Features/Small_Features/Add_inexact_locate_in_Periodic_3_triangulation_3)
- Tested in CGAL-4.5-Ic-12
- Approved by the Release Manager.
2014-04-16 16:22:31 +02:00
Laurent Rineau 5a05ba0577 Fix Doxygen bug in the documentation of Mesh_triangulation_3 2014-04-14 15:22:41 +02:00
Aymeric PELLE 0e9e80b872 Point type is deduced from the ImplicitFunction in the new wrapper.
In Implicit_multi_domain_to_labeling_function_wrapper, the point
type is deduced if ImplicitFunction is a pointer function, else it must
be a nested type of ImplicitFunction.
BGT isn't required anymore for this wrapper.
The constructor of Implicit_multi_domain_to_labeling_function_wrapper taking
only one argument has a new way for auto-making the vector of vector of
positions. In this case, the union of the components equals to the union
of the functions.
2014-03-31 18:42:47 +02:00
Aymeric PELLE d41b708958 Add some precision in the documentation. 2014-03-28 15:39:56 +01:00
Aymeric PELLE ae84316d52 Some correction in the documentation.
Labeled_mesh_domain_3 : LabelingFunction template parameter.
Implicit_multi_domain_to_labeling_function_wrapper :
Function template parameter.
2014-03-27 14:24:52 +01:00
Aymeric PELLE c15ff1c19c New implementation of Implicit_multi_domain_to_labeling_function_wrapper.
The user can indicate more precisely which components he wants.
For each component that the user want, he must provide the matching
vector of signs. All these vector of positions must be put in a vector
passed as second parameter to the constructor of that wrapper.
Doc and examples are updated.
2014-03-26 19:02:27 +01:00
Aymeric PELLE 31767a8411 Rename ..._labeled_function_wrapper to ..._labeling_function_wrapper.
Implicit_vector_to_labeled_function_wrapper is deprecated.
Examples, tests, docs are updated.
2014-03-25 15:25:42 +01:00
Aymeric PELLE 6691e2e332 Fix : wrappers documentation indicated wrong header files.
Documention:
Implicit_multi_domain_to_labeled_function_wrapper and
Implicit_vector_to_labeled_function are located in the file
Implicit_to_labeled_function.h.
2014-03-24 13:55:05 +01:00
Aymeric PELLE 1d72710e24 Documentation for a new domain and two wrapers.
- Labeled_mesh_domain_3
- Implicit_vector_to_labeled_function_wrapper
- Implicit_multi_domain_to_labeled_function_wrapper
2014-03-24 11:01:02 +01:00
Clement Jamin 157cd0465f Merge branch 'Mesh_3-parallel-cjamin-old' into Mesh_3-parallel-cjamin
Conflicts:
	Mesh_3/demo/Mesh_3/Mesh_3_optimization_plugin_cgal_code.cpp
	Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h
	Mesh_3/include/CGAL/Mesh_3/C3T3_helpers.h
	Mesh_3/include/CGAL/Mesh_3/Mesh_complex_3_in_triangulation_3_base.h
	Mesh_3/include/CGAL/Mesh_3/Mesh_global_optimizer.h
	Mesh_3/include/CGAL/Mesh_3/Sliver_perturber.h
	Mesh_3/include/CGAL/Mesh_3/Slivers_exuder.h
	Mesh_3/include/CGAL/Mesh_3/Triangulation_helpers.h
	Mesh_3/include/CGAL/Mesh_3/config.h
	Mesh_3/include/CGAL/Mesh_3/vertex_perturbation.h
	Mesh_3/include/CGAL/Polyhedral_mesh_domain_3.h
	Mesh_3/include/CGAL/exude_mesh_3.h
	Mesh_3/test/Mesh_3/test_meshing_utilities.h
	Triangulation_3/include/CGAL/Triangulation_cell_base_with_circumcenter_3.h
2014-03-10 17:01:03 +01:00
Clement Jamin b00eb1ffa2 Fixes the doc according to Monique's review 2014-02-17 08:06:49 +01:00
Jane Tournois 4d47194a7b Merge branch 'Mesh_3-fix_perturber_slivers_empty_bug-GF-rebased'
This branch fixes a bug in the sliver perturber.
It introduces some new data structures to backup the metadata
stored in cells before each perturbation. This allows to
recover these data without recomputing them in case the move
is reverted.

The bug fix comes from the fact that rec-omputed values might
have been different after the move from what they were before the
move, in a tetrahedron which is the same but for which the
Cell_handle is new.

Approved by the release manager.
2014-02-06 11:24:41 +01:00
Clement Jamin 5b6fc4b5a3 Doc: add a "todo" to add a reference to the future paper. 2014-01-23 11:41:07 +01:00
Jane Tournois 43113876bd fix documentation of concept MeshCellBase_3 2014-01-16 11:35:02 +01:00
Sébastien Loriot db43325f3a fix doc typo 2014-01-16 07:34:29 +01:00
Jane Tournois f809cce4f5 fix documentation bug 2013-12-20 15:37:59 +01:00
Jane Tournois dc2ef137fb documentation bug fix 2013-12-20 14:03:47 +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 02b0090b42 MeshCellBase_3 must be copy constructible 2013-11-25 14:35:30 +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
Laurent Rineau 3ad8f223cd Fix the documentation of the Tds parameters of cell base classes
And add see also between Compact_mesh_cell_base_3 and Mesh_cell_base_3.
2013-10-16 16:34:41 +02:00
Laurent Rineau fcbbe713d5 No longer deprecate Mesh_cell_base_3
Compact_mesh_cell_base_3 has a different API than Mesh_cell_base_3. Unless
one uses the default template parameters, the new API is less
convenient. We cannot deprecate Mesh_cell_base_3 so easily.
2013-10-16 16:34:41 +02:00
Clement Jamin c30ec5bcee Typos, spelling mistakes, sentence order... 2013-10-16 13:50:54 +02:00
Clement Jamin b00bed59c3 Typo 2013-10-16 13:04:15 +02:00
Clement Jamin b0d85423e1 Doc: added line breaks + minor corrections 2013-10-16 12:19:27 +02:00
Clement Jamin 29525dfcb7 Back-quotes for could_lock_zone and true + minor fixes + replace 0 by NULL 2013-10-15 10:27:35 +02:00
Clement Jamin 72aaf18f49 Minor fixes in documentation 2013-10-01 17:25:44 +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 039e47c497 doc bug fix: FT must be a sort of "FieldNumberTypeWithSqrt" (non-existent) 2013-09-04 15:24:57 +02:00
Laurent Rineau dd6e4fb8bf Cont. of "Fix a documentation bug"
Continuation of the following commit:
  | commit c4aed1cd67
  | Author: Laurent Rineau <laurent.rineau@cgal.org>
  | Date:   Wed Sep 4 12:25:57 2013 +0200
  |
  |     Fix a documentation bug, since the switch Object -> optional<variant>
2013-09-04 12:58:38 +02:00
Laurent Rineau c4aed1cd67 Fix a documentation bug, since the switch Object -> optional<variant> 2013-09-04 12:25:57 +02:00
Laurent Rineau ec6e2e5b58 Reformat the documentation of IntersectionGeometricTraits_3 2013-09-04 12:18:01 +02:00
Laurent Rineau e43b712432 Reformat the documentation of BisectionGeometricTraits_3 2013-09-03 17:26:08 +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 bb59c07424 Doc fix: parameter order 2013-07-23 17:13:06 +02:00
Clement Jamin 11fdd71222 Doc: fix a conflict-solving-bug introduced during the last "merge from master" 2013-07-16 20:30:07 +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
Clement Jamin 2f942612b4 Merge branch 'Mesh_3-fix_documentation-cjamin' of ssh://scm.cgal.org/var/git/cgal into Mesh_3-fix_documentation-cjamin 2013-07-05 12:51:13 +02:00
Clement Jamin f0a91b9c84 Fix link in the doc 2013-07-05 12:50:23 +02:00
Clement Jamin 97bef9652a Merge branch 'Mesh_3-fix_documentation-cjamin-old' into Mesh_3-fix_documentation-cjamin 2013-07-04 14:41:33 +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
Clement Jamin 159ca5fab8 Remove the "TBB malloc proxy" recommendation, since we don't use it anymore 2013-07-02 13:32:15 +02:00
Jane Tournois 404f2e0e3c merge 2013-06-21 10:01:19 +01:00
Jane Tournois 4a1f9cc831 deprecate Mesh_cell_base_3 and use Compact_mesh_cell_base_3 in Mesh_triangulation_3.h 2013-06-20 12:29:46 +02:00
Jane Tournois 6fa5caa574 deprecate Mesh_cell_base_3.h 2013-06-20 11:39:07 +02:00
Jane Tournois 4b63d8b44c remove deprecation to fix doxygen output 2013-06-20 11:26:58 +02:00
Jane Tournois 416a722417 Revert "complete of mesh cell base concept documentation"
This reverts commit 2f48fba7d8.
2013-06-20 11:02: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
Clement Jamin d38ea4d462 Documentation changes suggested by Pierre. 2013-06-11 13:21:50 +02:00
Philipp Möller 895245426a Fix some errors introduced by adding the titles 2013-05-30 18:09:42 +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 d4e379ba82 Small fixes in the generated Doxyfile.in 2013-05-30 15:32:33 +02:00
Ross Hemsley c0690f87f4 Manually inserted tags that could not be generated automatically
added in options that were in XML but were not moved across to new Doxyfile.in files.
2013-05-30 14:45:18 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Jane Tournois 2d24fa7095 improve documentation 2013-05-24 10:25:37 +02:00
Jane Tournois b9dfc6ef44 small fix in feature detection 2013-05-17 17:32:23 +02:00
Jane Tournois 957b53c4b1 keep only the compact_vertex_base, and rename it 2013-05-17 14:55:41 +02:00
Jane Tournois 9e8e4b805e fixed typo 2013-05-17 14:19:30 +02:00
Jane Tournois 52d6facc48 complete Polyhedral_mesh_domain_with_features_3 constructors with the one with a bounding_polyhedron 2013-05-17 14:18:56 +02:00
Jane Tournois 88c0a77406 fix polyhedral mesh domain documentation 2013-05-17 12:32:11 +02:00
Jane Tournois 7a80501ce5 fix documentation for is_special and other internal stuff of MeshVertexBase_3 2013-05-17 11:38:15 +02:00
Jane Tournois 2f48fba7d8 complete of mesh cell base concept documentation
delete mesh_cell_base which will be deprecated to favor Compact_mesh_cell_base
2013-05-17 11:20:14 +02:00
Jane Tournois e872e34fb0 add more about edge_size mandatory when 1D features are protected 2013-04-18 12:52:14 +02:00
Clement Jamin ecd4ce7bfc Added parallel performance to the doc 2013-04-16 11:03:52 +02:00
Jane Tournois a0e99f653d little improvement of CANT_IMPROVE_ANYMORE sentence 2013-04-12 12:16:20 +02:00
Jane Tournois 4a324da9f5 complete lloyd and odt return code with CANT_IMPROVE_ANYMORE 2013-04-12 11:51:13 +02:00
Jane Tournois 0cfffc67a3 add compact mesh cell/vertex base(s) to documentation
+ fix template parameters order in existing documentation
2013-04-02 17:03:19 +02:00
Jane Tournois ef60b9361b fix order of template parameters. Make it consistent with the code 2013-03-29 17:15:48 +01:00
Jane Tournois 2713d26cb7 add invalidate_circumcenter 2013-03-29 16:15:08 +01:00
Jane Tournois d8134a8bbb fix last commit 2013-03-29 16:11:07 +01:00
Jane Tournois 6ecdbe83d3 add intrusive_list stuff to vertex base and cell base
+
add is_special and set_special to vertexbase
2013-03-29 16:05:11 +01:00
Clement Jamin 09c0f049a2 Removed useless "CGAL::" 2013-03-29 15:50:04 +01:00
Jane Tournois 2a27c968e3 complete previous commit 2013-03-29 15:27:41 +01:00
Jane Tournois 5a90be098b add constructor using bounding polyhedron 2013-03-29 15:24:35 +01:00
Jane Tournois 04a2ffa7dc say that edge_size should be set when protect_edges is used 2013-03-29 15:09:22 +01:00
Mariette Yvinec 92b406ee6a fixed the doc of the triangulation type 2013-03-29 10:31:22 +01:00
Clement Jamin 612ec45b4d Updated MeshComplex_3InTriangulation_3 concept 2013-03-28 18:32:29 +01:00
Clement Jamin 508084ac7c Updated Mesh_triangulation_3 doc. 2013-03-28 11:29:57 +01:00
Clement Jamin 729834f9be Updated Mesh_triangulation_3 doc. 2013-03-28 11:21:46 +01:00
Clement Jamin e92ffb76d9 It's more simple, now that the user can't provide its own TDS anymore. 2013-03-28 11:07:29 +01:00
Clement Jamin ec978401d7 Rephrased the "CGAL::Mesh_triangulation_3<>::type" thing
(cherry picked from commit 17cfd743af)
2013-03-28 10:39:53 +01:00
Mariette Yvinec e3ff82970e Changed the doc for the triangulation type in concept Complex_3InTriangulation_3 2013-03-28 10:39:53 +01:00
Clement Jamin 17cfd743af Rephrased the "CGAL::Mesh_triangulation_3<>::type" thing 2013-03-28 10:05:57 +01:00
Mariette Yvinec 9a3aa487fd Changed the doc for the triangulation type in concept Complex_3InTriangulation_3 2013-03-26 19:19:08 +01:00
Jane Tournois 3c5cfea454 missing for freeze in parameters::lloyd() and parameters::odt() 2013-03-25 14:48:51 +01:00
Jane Tournois 6ae05570ca typos about freeze 2013-03-25 14:39:35 +01:00
Jane Tournois a8f919fbc1 about return_code ALL_VERTICES_FROZEN 2013-03-21 15:58:39 +01:00
Jane Tournois bfdcc57a4a add do_freeze parameter to documentation 2013-03-21 15:39:24 +01:00
Clement Jamin d38309e398 User doc 2013-03-14 18:39:01 +01:00
Clement Jamin d5699c3eb5 Updated the doc for vertex & cell classes
We don't require xx_erase_counter functions anymore when we're sequential
2013-03-14 17:46:14 +01:00
Clement Jamin 4ee6fab31e User manual and package description. 2013-03-14 17:10:09 +01:00
Clement Jamin a41caa3805 Added concurrency-related requirements to cell and vertex concepts 2013-03-14 16:42:34 +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 7e59c14580 add a header to classified reference pages using a doxygen macro 2013-03-12 14:33:49 +01:00
Clement Jamin 1346fa6a79 Updated Mesh_triangulation_3 documentation 2013-03-11 15:32:07 +01:00
Sébastien Loriot 9911a77ed8 fix doxygen warning for Mesh_3
I removed the usage of \param as the notation used in this package
for boost parameter is not supported by doxygen.
2013-01-24 22:05:32 +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 2daeae5678 fix bad nesting level (in consistent nb of #) 2013-01-07 17:40:48 +01:00
Sébastien Loriot 416983e90c using \return doxygen command to document return type 2013-01-07 11:13:42 +01:00
Sébastien Loriot 4eb9c27cc8 <br> shall not be used inside backtick 2013-01-07 11:12:55 +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 7e095c7a7a Merge branch 'Documentation-flat-ref-manual-pmoeller' 2013-01-04 15:19:57 +01:00
Sébastien Loriot 42d15a11d0 using uniform markups in classified reference pages 2013-01-04 15:16:40 +01:00
Sébastien Loriot b1de512651 add classified ref man for Mesh_3 2013-01-04 11:26:57 +01:00
Andreas Fabri 54a9101463 polish Mesh_3 2012-12-28 11:26:28 +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 8a464d3ac5 polish Skin_surface 2012-11-23 13:06:24 +01:00
Sébastien Loriot bfca42081d add missing backquotes in cgalModels 2012-11-23 09:55:55 +01:00
Sébastien Loriot 0f69c2a512 remove cpp0x namespace from documentation pages 2012-11-14 16:16:15 +01:00
Sébastien Loriot 8d741d504d remove % in section name 2012-11-14 16:10:15 +01:00
Andreas Fabri d2992b76b3 Make some \section \subsection 2012-11-14 15:39:46 +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 5ee1081f92 using cgal macros for all figures 2012-11-08 17:17:29 +00: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
Andreas Fabri 59877a8d52 linking and unlinking 2012-10-30 13:40:03 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Andreas Fabri 1bf739771a various improvements 2012-10-24 19:03:29 +00:00
Andreas Fabri 5c39718908 various improvements 2012-10-24 18:02:49 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Philipp Möller 81c8c662d6 Fix some PkgDependsOn to stay inside the package overview, fix an
off-by-one in hacks.js, add a missing dependency
2012-10-18 16:31:12 +00:00
Laurent Rineau 4bf5ccb76c Disable auto-linking for Function and Field 2012-10-08 11:59:30 +00:00
Laurent Rineau 5a2ec5d9c6 Mesh_3 documentation depends on Surface_mesher documentation...
...for SurfaceMeshVertexBase_3.

On the other hand, RegularTriangulationVertexBase_3 does not exist! Thanks
to Doxygen for detecting that bug.
2012-10-08 11:50:10 +00:00
Laurent Rineau f0c7bc432e Fix that page
- Correct indentation of the piece of code
- s/FieldType/Field/
2012-10-08 10:58:15 +00:00
Philipp Möller 24b7b586cc Remove the borks that were created by the script that introduced
anchors for top-level headings.
2012-10-05 13:07:09 +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
Laurent Rineau 44d051d631 Uniformly s/SqrtFieldNumberType/FieldWithSqrt/g
SqrtFieldNumberType is no longer documented. (For how long?)

I have also rephrase "A `SqrtFieldNumberType`" to "A model of the
`SqrtFieldNumberType` concept", that sounds more correct.
2012-10-03 12:10:00 +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 9d96057636 Add PkgDependsOn to the package summary 2012-09-27 11:13:37 +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
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Philipp Möller 792ab96e94 Port documentation changes that happened in the merge. 2012-09-20 12:37:50 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Mariette Yvinec 69bbb0f174 MY fixes 2012-09-17 09:35:57 +00:00
Andreas Fabri d19b639df3 smaller headings; use of \param 2012-09-14 12:11:13 +00:00
Philipp Möller 84d02258fb Briefs for groups. 2012-09-14 09:50:17 +00:00
Andreas Fabri dce9cc543c mainly \tparam 2012-09-14 09:48:56 +00:00
Andreas Fabri 9477ce88d1 regroup secondary concepts 2012-09-13 16:37:58 +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 275e47e321 replace '' by ** 2012-09-12 09:56:19 +00:00
Andreas Fabri fbfdf8d361 subgrouping 2012-08-31 15:25:12 +00:00
Laurent Rineau c79ccae2fe Fix warnings 2012-08-31 12:37:25 +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 2731d9bc99 fix linking in \has Models by prefixing with CGAL namespace 2012-08-27 08:58:17 +00:00
Andreas Fabri 6a380d3252 fix linking in \has Models by backquoting 2012-08-27 08:42:34 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +00:00
Andreas Fabri 4f1993796e fix linking of functions 2012-08-21 08:04:51 +00:00
Andreas Fabri fb5fc961b9 capitalize 2012-08-21 07:18:04 +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 d5c15dafde fix double \cite commands 2012-08-17 13:46:35 +00:00
Philipp Möller 6a45864c1a Throw a set of ported doc files under version control 2012-08-09 16:07:44 +00:00