Commit Graph

172 Commits

Author SHA1 Message Date
Guillaume Damiand e7a8d85652 Update insertion examples in CMap and add precision in the doc. 2016-11-29 11:43:19 +01:00
Guillaume Damiand faffe50656 Update doc for examples dynamic_onmerge (both CMap and GMap) 2016-11-29 11:43:18 +01:00
Guillaume Damiand a7cef53494 Use the macro tred 2016-11-29 11:43:16 +01:00
Guillaume Damiand 5c417c2cf2 Improve the tred macro to allow to be used itself with macro 2016-11-29 11:43:16 +01:00
Guillaume Damiand 213ae2c87b Add some links to the GMap package. 2016-11-29 11:43:16 +01:00
Guillaume Damiand 1163ee6ab0 Update the name and label of figures in order to have the same naming convention for cmap and gmap. 2016-11-29 11:43:14 +01:00
Guillaume Damiand e8180ff4ae Update following Andreas first review. 2016-11-29 11:43:12 +01:00
Guillaume Damiand 75ee34d7ea Update doc of Gmap to highlight differences 2016-11-29 11:43:12 +01:00
Guillaume Damiand a23ee58d91 Bug fix for global function that are removed 2016-11-29 11:43:11 +01:00
Guillaume Damiand 098f87db0d Remove new line in the doc to simplify the comparison 2016-11-29 11:43:11 +01:00
Guillaume Damiand 1de9bb136b Add a note about GMap for non orientable objects. 2016-11-29 11:43:11 +01:00
Guillaume Damiand b5843faa1b Combinatorial map ref manual to add the fact that dart and attribute concerns combinatorial map. 2016-11-29 11:43:10 +01:00
Guillaume Damiand 47fe19a13a Cleanup fig in CMap. 2016-11-29 11:43:10 +01:00
Guillaume Damiand d81b732761 Update 2 figs; plus remove unused pdf files. 2016-11-29 11:43:08 +01:00
Guillaume Damiand 261586d660 Update comments in Combinatorial map to add the possibility of using generalized maps. 2016-11-29 11:43:08 +01:00
Guillaume Damiand 79febdd8a3 All figures of CMap and LCC are now in svg. 2016-11-29 11:43:00 +01:00
Sébastien Loriot a9840bf87c doc bugfix
remove an extra }
2016-09-29 08:57:26 +02:00
Sébastien Loriot 7f350f7507 remove old API deprecated since CGAL 4.4 2016-07-21 11:51:11 +02:00
Guillaume Damiand 900f5efe4b Correct link in doc 2016-04-11 18:34:51 +02:00
Guillaume Damiand 406a2d4f1c Update user manual 2016-03-10 16:47:55 +01:00
Guillaume Damiand 2367827151 Update the doc to deprecate all global operations. 2016-03-10 16:37:00 +01:00
Guillaume Damiand 7741e0accb Update bug in doc of CMap. 2016-03-10 10:47:06 +01:00
Andreas Fabri b926bfc21d Update PackageDescription.txt 2016-02-26 20:53:46 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Sébastien Loriot 72863bfe44 fix doxygen warnings 2016-02-04 21:19:36 +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
Guillaume Damiand 237697b7e0 Update Combinatorial_map.txt 2015-11-04 10:20:19 +01:00
Guillaume Damiand 0f7bb719f3 Merge branch 'CMap-marks_with_exceptions-sbrandel-old' into CMap-marks_with_exceptions-sbrandel 2015-10-01 18:31:45 +02:00
Guillaume Damiand 586eb0a266 Update doc of XXX_handle (documentation bug fix). 2015-08-31 17:28:36 +02:00
Laurent Rineau 08666dce25 Merge pull request #179 from afabri/CGAL-add_hash-GF
Add boost::hash and std::hash

https://cgal.geometryfactory.com/CGAL/Members/wiki/Features/Small_Features/hash

Conflicts:
	Installation/changes.html
2015-07-17 15:39:18 +02:00
Guillaume Damiand e94b687022 Add \ after i.e. in doxygen comment 2015-06-24 09:50:20 +02:00
Guillaume Damiand d67542fb59 Add is_xxx_used in cmap for dart and attributes; add tests in CMap and LCC. 2015-06-22 16:50:56 +02:00
Guillaume Damiand a8226e8743 Add sentence about handle that are LessThanComparable and Hashable 2015-06-22 15:45:07 +02:00
Sylvain Brandel 25b2727381 mark type modified from int to size_type, exception thrown in get_new_mark and test added in the test-suite 2015-06-12 15:11:04 +02:00
Guillaume Damiand 31f97645d9 Finalize doc + example. 2015-01-05 18:37:50 +01:00
Guillaume Damiand bdc0dee6ce Update operations to use are_attributes_automatically_managed 2014-12-23 22:15:49 +01:00
Guillaume Damiand 1ac0e7ea8d add the three new functions in CombinatorialMap concept. 2014-12-23 21:39:33 +01: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
Guillaume Damiand 375e7a919e no more -> no longer 2013-11-27 18:13:05 +01:00
Guillaume Damiand db7c14cc58 * Document the deprecated function in Dart, CMap concept and LCC class;
* Add paragraph in changes.html;
* Bugfix in Linear_cell_complex_constructors for lcc without 2-attributes.
2013-11-21 10:23:24 +01:00
Guillaume Damiand b35422939a Add Ken as contributer. 2013-11-19 16:35:09 +01:00
Guillaume Damiand c34014bcf7 Doc update. 2013-11-19 16:31:53 +01:00
Guillaume Damiand a4ec793044 Documentation of modifications in CombinatorialMap and Dart. 2013-11-19 15:29:24 +01:00
Guillaume Damiand 08d5670307 Update the doc of functions one_dart_per_incident_cell(dh), darts_of_cell(dh) and darts_of_orbit(dh) in the concept CombinatorialMap.
(small feature CMap doc first dart of ranges pre-approved 28 June 2013)
2013-09-05 20:30:46 +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 74a1ac055e remove pdf files from doxygen doc include path 2013-07-25 11:15:18 +02:00
Guillaume Damiand 374ca0aea8 Add missing doc for reverse orienration functions; correction in the doc of cmap contructor. 2013-06-26 11:11:43 +02:00
Guillaume Damiand eebf72eb3d Doc for dynamic onsplit/onmerge functors. 2013-06-17 12:37:33 +02:00
Guillaume Damiand 98a4e30f34 Merge branch 'Combinatorial_map_copy2-gdamiand'
Approved by the release manager
2013-06-14 13:33:46 +02:00
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Guillaume Damiand d1395ba609 Add doc for new constructor, operator= and swap method. 2013-06-13 17:58:31 +02:00
Philipp Möller fd0a2b46f4 Merge branch 'Documentation-remove-dxyassist-pmoeller' 2013-06-03 20:37:20 +02:00
Guillaume Damiand db584a8465 Bug fix in doc 2013-05-31 15:05:19 +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 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot f45c8ccb18 remove todos 2013-05-28 15:26:42 +02:00
Sébastien Loriot 170c619a2d fix places where the <div> added by cgalAdvanced conflicts with other html tags 2013-05-28 09:51:49 +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
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 7d2903e230 add classified reference manual pages 2013-03-12 14:51:52 +01:00
Guillaume Damiand b1d65019c1 Doxygen LCC ok. 2013-03-01 16:30:48 +01:00
Guillaume Damiand 2a04b964cd * More links in CMap doc.
* Add tag in doxyassist for LCC.
* Ok for LCC user manual.
2013-03-01 13:45:52 +01:00
Guillaume Damiand 74b589c466 Correct some links; add #include for operations. 2013-03-01 11:11:58 +01:00
Guillaume Damiand f3c4f7a319 * Create a group for classes in CMap doc doxygen version.
* Move figure pdf and xfig versions in subdir.
2013-02-28 20:55:35 +01:00
Guillaume Damiand 8734f2cf51 Doxygen version of the CMap doc. 2013-02-28 17:19:11 +01:00
Sébastien Loriot 9c16cafb80 inline DartWrapper concept that did not exist in the original documentation
The page CombinatorialMapItems is now similar to the original one.
2013-01-24 12:37:47 +01:00
Sébastien Loriot af7dcfbe6d using template alias declaration to document class Attribute_handle 2013-01-24 07:03:25 +01:00
Sébastien Loriot 57aae7c7bf using C++11 template alias notation to better document nested template classes
The big advantage compared to nested classes is that is it places in the
desired group and it is inline.
2013-01-21 18:22:05 +01:00
Sébastien Loriot b6c85a19a4 remove linking warning in doxygen doc 2013-01-18 17:36:55 +01:00
Sébastien Loriot c0289881c2 remove extra space 2013-01-07 18:30:25 +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 0c62e021ac Remove unused doc in CombinatorialMap 2012-12-21 14:07:03 +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 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
Andreas Fabri eb41ac1765 typo 2012-11-22 09:54:22 +01:00
Sébastien Loriot 0f69c2a512 remove cpp0x namespace from documentation pages 2012-11-14 16:16:15 +01:00
Guillaume Damiand 15e07360a7 Correct a link (and test git commit ;) 2012-11-14 09:00:51 +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 974621b58f start using new figure macros.
For Combinatorial maps, I reintroduced the original anchor names as they
were still in use in the reference manual.
2012-11-08 10:55:09 +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 87c689b35f use \link\endlink 2012-10-31 20:25:04 +00:00
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Andreas Fabri 7736798599 linking unlinking 2012-10-30 13:09:46 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Guillaume Damiand 40be2c8ff6 Links in CMap concept; almost finished... 2012-10-19 14:09:01 +00:00
Guillaume Damiand d22b3862de de math 2012-10-19 11:42:09 +00:00
Guillaume Damiand 535a8e4c87 Brief 2012-10-19 09:39:41 +00:00
Guillaume Damiand 2c86697333 Improve brief; remove named instance. 2012-10-19 09:30:43 +00:00
Guillaume Damiand 8153358ae7 Improve brief; remove named instance. 2012-10-19 09:24:51 +00:00
Guillaume Damiand 69034abfbe Correction of some refs. 2012-10-19 08:39:23 +00:00
Guillaume Damiand 9b87fb5db8 Link to LCC in CMap doc is now ok. 2012-10-19 08:09:06 +00:00
Guillaume Damiand 6705d63432 Add group for concept CombinatorialMap. This has no effect on the generated doc but could have if we set the INLINE_GROUPED_CLASSES option. 2012-10-19 08:01:31 +00:00
Guillaume Damiand 09106a3d51 Links in CMap user manual: almost finished (and it is very nice ;) 2012-10-18 19:52:27 +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
Philipp Möller 6615bcee09 Fix some minor glitches in headings 2012-10-18 12:55:17 +00:00
Philipp Möller c48ef2954c Small fixes 2012-10-17 08:36:09 +00:00
Guillaume Damiand c79f36cd5d Try to not document nested classes for attributes. 2012-10-12 12:13:28 +00:00