Commit Graph

108 Commits

Author SHA1 Message Date
Sebastien Loriot 97bd1cf428
Rename home page of reference manuals to "Reference Manual" (#8904)
Before: "Pkg Reference"
After: "Reference Manual"

No need to repeat the package name as it is on the line above.

Example output
![Screenshot from 2025-05-22
16-18-54](https://github.com/user-attachments/assets/ed285e12-d95c-4ec2-934d-12f4c7aa014c)
2025-05-26 11:47:37 +02:00
Sébastien Loriot 13609a6966 no need to repeat the package name as it is on the line above 2025-05-22 17:53:41 +02:00
Andreas Fabri 2bdeff8687 counter-clockwise -> counterclockwise 2025-05-15 07:41:00 +01:00
Sébastien Loriot 66965f3a07 remove todo 2025-02-14 11:03:32 +01:00
albert-github dd02af92a2 issue #8515 Spelling mistakes found checking `en-GB` to `en-US`
Spelling corrections, `en-GB` -> `en-US`
2024-10-05 11:28:29 +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 a0320dd7b4 Merge branch 'master' into feature/issue_7395
# Conflicts:
#	Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h
2023-07-13 10:33:18 +02:00
albert-github 301728a8a9 issue #7395 Improvement of layout of model relations
- Completed the cgalModels part
2023-07-09 12:43:36 +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 b3af96caa1 issue #7454 Consistency of BigO notations
Create `cgalBigO` marco and used it.
(`The macro `cgalBigOLarge` is for special situations where we need bigger round brackets)
2023-07-04 16:23:14 +02:00
albert-github 2d60f46985 issue #7231 Improvement of layout of refines relations.
- Adjusted cgalRefines according to reviews
- Implemented it in all files
2023-03-14 17:37:50 +01:00
albert-github c32b1f4127 spelling corrections
Some spelling corrections (Directories starting with `S` rest - `W`),
2022-11-16 13:22:39 +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
albert-github f5a4ce7e0f Segment_Delaunay_graph_2: Incorrect backticks
Correcting some incorrect backticks:
Inside code part there should not be extra backticks
- Segment_Delaunay_graph_2/classCGAL_1_1Segment__Delaunay__graph__2.html
- Segment_Delaunay_graph_2/classCGAL_1_1Segment__Delaunay__graph__hierarchy__2.html

In the see also section there was an incorrect backtick inside the
- Segment_Delaunay_graph_2/classCGAL_1_1Segment__Delaunay__graph__storage__traits__with__info__2.html
2022-09-28 17:39:30 +02:00
Laurent Rineau 3ab3b10d47 Merge pull request #5247 from MaelRL/SDG-Fix_doc-GF
Doc improvements for TDS-related classes
2021-03-03 17:38:18 +01:00
Mael Rouxel-Labbé 87ecfae6f3 Change SDG2 vertex base's requirement to TDS2 vertex (full T2 vertex not needed) 2021-02-17 10:56:47 +01:00
Maxime Gimeno fb3746168d remove \sc 2021-02-05 11:10:20 +01:00
Andreas Fabri 41a3d1c448 Add initial version of doc of with_info classes 2021-01-19 16:43:17 +00:00
Mael Rouxel-Labbé 6042946581 Misc fixes 2020-12-06 12:37:58 +01:00
Mael Rouxel-Labbé 74e8414241 Properly document SDG storage traits + many other SDG2 doc fixes 2020-12-05 15:20:31 +01:00
Mael Rouxel-Labbé 723890e388 Misc tiny doc fixes (broken links, grammar, etc.) 2020-12-05 11:49:27 +01:00
Mael Rouxel-Labbé 702d2ddf86 Fix documentation of TDS vertex/face/cell requirements in TDS-using classes 2020-12-05 11:42:21 +01:00
Mael Rouxel-Labbé f4300bbacd Add some missing const / references in documentations 2020-12-05 11:20:26 +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
Sébastien Loriot cf99ea072d Merge remote-tracking branch 'cgal/releases/CGAL-4.14-branch' 2020-03-16 16:19:38 +01:00
Mael Rouxel-Labbé 57465431e8 Fix grammar 2020-03-10 15:26:34 +01:00
Mael Rouxel-Labbé fe7c4629c1 Tiny punctuation change 2020-03-10 15:20:16 +01:00
Mael Rouxel-Labbé 0729d1b0d1 Update documentations of SDG/AG2: Filtered_exact has been removed...
... 16 years ago !
2020-03-10 15:17:50 +01:00
Sébastien Loriot fbafb9d06f fix remaining mismatches and fix bugs 2019-07-10 11:40:45 +02:00
Sébastien Loriot 983645a51a match @{ and @} 2019-07-05 21:49:46 +02:00
Andreas Fabri 5141c6d95d Fix wording in SVD User Manaul 2019-06-11 12:54:34 +02:00
Andreas Fabri 8131d4efda Fix order of documentation of template parameters 2019-05-26 18:14:24 +02:00
Andreas Fabri d4584ba983 Fix typos 2019-05-26 11:54:11 +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
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
Sébastien Loriot 19adf3b05e make the doc match struct/class with the implementation 2017-11-17 11:34:55 +01:00
Mael Rouxel-Labbé fba90bcd32 Fixed segment Delaunay graph concepts
SDG inherits from T2, so the concepts must refine T2's
2017-06-28 10:15:30 +02:00
Andreas Fabri cd4457407b Fix typo 2016-03-04 17:31:32 +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
Andreas Fabri b3ed4b933a The class Segment_Delaunay_graph_without_intersections_2 does not exist 2015-10-13 15:47:30 +02:00
Andreas Fabri c37ffa6613 use typedef not derivation 2015-04-29 11:58:02 +02:00
Andreas Fabri 6737e8e43b use figure macros 2015-04-29 11:58:02 +02:00
Andreas Fabri d6d5471161 boolean -> Boolean 2015-04-29 11:58:02 +02:00
Andreas Fabri 4a15ac8795 prefix classes with CGAL when outside the namespace CGAL 2015-04-29 11:58:01 +02:00