Commit Graph

84 Commits

Author SHA1 Message Date
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 ad41766454 issue #7395 Improvement of layout of model relations
Corrected `cgalModels` to `cgalHasModes` inside `cgalHasNodelsBegin` / `cgalHasModelsEnd`
2023-07-18 13:23:37 +02:00
albert-github 4e5578d469 issue #7395 Improvement of layout of model relations
- based on review
2023-07-15 13:12:15 +02:00
albert-github ee2a55279d issue #7395 Improvement of layout of model relations
- Completed the cgalHasModel part
- corrected spelling of `Has Model` and `Is Model Of` to `Has model` and `Is model of`
2023-07-06 17:35:34 +02:00
albert-github 2329cb714d Making description of author(s) of a package consistent
After review
Removing `,` in case of 2 authors so it is also consistent with the bibliography.
2023-02-03 12:21:50 +01: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
albert-github 45478184de spelling corrections
Some spelling corrections (Directories starting with `E`-` L`),
some backward work
some forward work
2022-11-15 13:39:40 +01:00
Sébastien Loriot 0779373835 extra run of the script to remove tabs and trailing whitespaces
right after the  merge of 4.14 release branch

+ manual fix on one line in:
    * Arrangement_on_surface_2/include/CGAL/IO/Arr_text_formatter.h
    * .travis/generate_travis.sh
2020-03-26 14:16:06 +01:00
Sébastien Loriot 0a46621dc6 Merge branch 'cgal/releases/CGAL-4.14-branch'
whitespace+tab removal, merged with option -Xignore-all-space
2020-03-26 13:28:46 +01:00
Sébastien Loriot 590612a563 run the script to remove tabs and trailing whitespaces 2020-03-26 13:25:16 +01:00
Mael Rouxel-Labbé 2848158354 Fix typos 2019-05-20 08:54:04 +02: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
albert-github d6641b569f Problems with formulas in documentation
There were some problems with formulas in the documentation most of them resulting in 'Undefined control sequence ' (MathJax output)

Note problem with the Bounding Volumes has not been resolved, separate issue created #3522
2018-12-09 18:31:13 +01:00
Sébastien Loriot 2f9408f867 rename link name to match package name 2018-10-08 10:28:55 +02:00
Sébastien Loriot 3dd0aa112d rename macro not following the convention 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 ae193e5af3 Document Eigen dependency in PackageDescription.txt of packages 2018-06-19 11:00:02 +02:00
Simon Giraudot 41d554fe58 Deprecating Diagonalize_traits: document dependency to Eigen 2018-06-19 10:57:55 +02:00
Sébastien Loriot 742a615527 fix doc warnings triggered essentially by the improvement of doxygen 2018-04-25 23:36: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
Simon Giraudot af8e73750c Merge branch 'CGAL-Solver-package-GF-old' into CGAL-Solver-package-GF 2015-08-20 11:51:34 +02:00
Andreas Fabri df7bcccdc0 change several package descriptions 2015-04-14 11:21:16 +02:00
Andreas Fabri 71aed48848 cleanup 2015-04-02 14:08:18 +02:00
Andreas Fabri c50448e918 move SvdTraits 2015-03-30 08:51:12 +02:00
Andreas Fabri 83f1d1b29a move files 2015-03-25 08:57:00 +01:00
Andreas Fabri 0e94b47457 improve jet fitting manual 2015-03-13 10:32:06 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +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
Sébastien Loriot b2b7e5cb7c bugfix to avoid assuming Monge_via_jet_fitting has default template parameters 2014-01-23 10:32:30 +01:00
Laurent Rineau a601b7bc06 Remove a superfluous .cpp (also from the documentation)
Follow-up to the following commit:
  | commit d2f0eff3cb
  | Author: Andreas Fabri <andreas.fabri@geometryfactory.com>
  | Date:   Tue Aug 27 09:56:39 2013 +0200
  |
  |     Switch to Simple_cartesian.
  |     Remove a superfluous .cpp
  |     Reorder #includes
2013-08-29 11:16:54 +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 b2ef3b8673 Merge branch 'doc-remove_gif-local'
Successfully test in CGAL-4.3-Ic-102

This commit fixes a few issues in the doxygen documentation and in particular
the figure for the generation of latex doc.

Approved by the interim release manager

xplain why this merge is necessary,
2013-07-26 17:50:07 +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
Sébastien Loriot 74a1ac055e remove pdf files from doxygen doc include path 2013-07-25 11:15:18 +02:00
Sébastien Loriot 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +02:00
Sébastien Loriot 4389b0bac8 remove the usage of gif in the doxygen doc as pdflatex does handle them
replace the files with png
2013-07-25 11:06: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
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
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 890b02ead6 add last missing classified reference manual 2013-03-12 18:46:37 +01:00
Sébastien Loriot 46e4ceead9 add concepts Matrix and Vector in SvdTraits to get nested types in SvdTraits
in the old documentation the concepts were inlined in the SvdTraits
2013-01-24 09:12:48 +01:00
Sébastien Loriot 6785665537 add missing reference 2013-01-04 16:09:20 +01:00
Andreas Fabri b71421e326 polish Jet_fitting 2012-12-28 19:58:05 +01:00