Commit Graph

53 Commits

Author SHA1 Message Date
Sébastien Loriot 66965f3a07 remove todo 2025-02-14 11:03:32 +01:00
Laurent Rineau 2a2031df3b Rename cgallab to CGALlab
@janetournois (see https://github.com/CGAL/cgal/pull/8149#issuecomment-2066444180
2024-04-23 15:09:51 +02:00
Laurent Rineau 621859b526 Rename Polyhedron demo to CGAL Lab
And announce it in the `CHANGES.md`.
2024-04-18 12:39:30 +02:00
albert-github 57e900b47c Making description of author(s) of a package consistent
- use `\cgalPckAuthor` in case of one author
- use of `\cgalPckAuthors` in case of multiple authors
- using in case of multiple authors always `, and `
- in the 1.9.6 `BaseDoxyfile.in` let the `\cgalPckAuthors` point to `\cgalPckAuthor` to get consistent output (not done for other versions as in the past the `ALIASES` could not call one another).
2023-02-02 18:40:44 +01:00
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Sébastien Loriot 59bc453b42 first batch of replacement for level 1 in classified ref man
command used:
grep -l  "##" */doc/*/PackageDescription.txt | xargs  sed -i  -E 's/\#\#\s*([[:print:]]+[[:alnum:]])\s*\#\#\s*$/\\cgalCRPSection{\1}/'
2019-02-14 10:32:39 +01:00
Sébastien Loriot 2f9408f867 rename link name to match package name 2018-10-08 10:28:55 +02:00
Sébastien Loriot ea240cfac5 use \PkgXXX instead of \PkgXXXSummary 2018-10-08 10:28:44 +02:00
Sébastien Loriot a2e8a1c68f add the suffix Ref to doxygen link to reference 2018-10-08 10:26:56 +02:00
Simon Giraudot 41d554fe58 Deprecating Diagonalize_traits: document dependency to Eigen 2018-06-19 10:57:55 +02:00
Simon Giraudot 3609aa71c3 Add note in doc about Eigen/efficiency 2017-04-24 11:48:21 +02:00
Maxime Gimeno a01593e0bb Unify the links to the Polyhedron demo in the package descriptions. 2017-01-10 14:56:52 +01:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +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
Sébastien Loriot 6d5a92ebcb try to improve cgalRequires removal 2015-11-23 22:06:06 +01:00
Maxime Gimeno 7b4267c162 Replacement of cgalRequires
-fix for #291
2015-11-23 22:06:06 +01:00
Sébastien Loriot 3e88b629e9 DiagonalizeTraits -> DiagonalizeTraits_ for the template parameter name 2015-09-21 07:45:58 +02:00
Simon Giraudot a4f242a0cc Replace Internal_diagonalize_traits by Diagonalize_traits + corrections in Concepts/Models 2015-09-16 11:41:26 +02:00
Simon Giraudot 63f77a05a5 Merge branch 'CGAL-Solver-package-GF-old' into CGAL-Solver-package-GF 2015-09-07 10:01:12 +02:00
Simon Giraudot a002127c0a Correction in doc of PCA (missing template) 2015-09-03 14:37:31 +02:00
Simon Giraudot 09f3659353 Improving doc 2015-09-02 15:40:30 +02:00
Simon Giraudot e3ce17eb0a Update doc of PCA in accordance with Solver interface 2015-09-01 12:40:10 +02:00
Sébastien Loriot 457aa2b7f0 link to the package function and not the kernel one 2015-08-24 17:14:45 +02:00
Sébastien Loriot 979306eb93 add a link to common demo dlls and update demo macro to avoid repeating Demo 2013-10-22 12:16:48 +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
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 e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Sébastien Loriot 7ecf2981af rename kernel global function groups 2013-01-09 19:48:39 +01:00
Sébastien Loriot fc12a8e7bc rename global function groups for PCA 2013-01-09 08:32:35 +01:00
Sébastien Loriot ff651ef172 add missing examples in PCA doc 2013-01-08 17:50:30 +01:00
Sébastien Loriot b6c2d31d40 fix linking to barycenter and centroid in PCA 2013-01-08 17:50:30 +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 4e19f0d8a8 polishing 2012-11-29 18:51:01 +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 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
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +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 8fb620bd7b fix documentation bugs 2012-09-25 10:22:41 +00:00
Philipp Möller a3efddcdea Fix the collapsed overloads. 2012-09-24 09:30:51 +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