Commit Graph

162 Commits

Author SHA1 Message Date
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
Guillaume Damiand b3b37441e5 wip for CMap doc: pb for links on methods. 2012-10-12 11:54:03 +00:00
Guillaume Damiand 14f9308497 Doxygenization of CMap user manual 2012-10-12 09:32:01 +00:00
Guillaume Damiand 2d1e4b6ac0 remove double bold 2012-10-12 07:38:50 +00:00
Guillaume Damiand 552bd95206 remove ldots 2012-10-12 07:35:34 +00:00
Guillaume Damiand d6e4eba819 No demo in CMap 2012-10-12 07:19:54 +00:00
Guillaume Damiand a217d29539 Indend inlined example 2012-10-09 19:12:59 +00:00
Guillaume Damiand 421c02cda3 Section links 2012-10-09 19:11:58 +00:00
Guillaume Damiand 14fe1b1cd7 Refs for figures 2012-10-09 18:21:34 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Philipp Möller bdf6f2e47d Small fixes for some awkward back-ticks and correctly link in Polygon. 2012-10-03 13:19:39 +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
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
Guillaume Damiand 311b28b46a Merge 2 figures in one: ok for user manual. 2012-09-18 18:49:17 +00:00
Guillaume Damiand 4efb3ffec3 Start to merge 2 figures in one. 2012-09-18 18:14:47 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller 51e0b8e9d1 move type docs to the right place 2012-09-13 16:37:28 +00:00
Andreas Fabri 75548fddb9 various fixes 2012-09-13 14:48:53 +00:00
Philipp Möller 53ef8d0290 spacing between number \f$ 2012-09-13 13:55:43 +00:00
Philipp Möller ecf6634f8e Add Combinatorial_map doc 2012-09-13 13:15:32 +00:00