46923342ad
Merge pull request #7576 from albert-github/feature/issue_7395
...
issue #7395 Improvement of layout of model relations
# Conflicts:
# Kernel_23/doc/Kernel_23/CGAL/Vector_2.h
2023-09-07 10:48:34 +02:00
55ea7ba7ec
More fixes
2023-08-22 10:21:46 +01:00
32054661c7
issue #7395 Improvement of layout of model relations
...
Replacing the `cgalModelsBare` construct with a `begin` / `end` construct so no less understandable constructs with `\,` and `\n` are necessary.
2023-07-21 19:21:09 +02:00
ad41766454
issue #7395 Improvement of layout of model relations
...
Corrected `cgalModels` to `cgalHasModes` inside `cgalHasNodelsBegin` / `cgalHasModelsEnd`
2023-07-18 13:23:37 +02:00
4e5578d469
issue #7395 Improvement of layout of model relations
...
- based on review
2023-07-15 13:12:15 +02:00
301728a8a9
issue #7395 Improvement of layout of model relations
...
- Completed the cgalModels part
2023-07-09 12:43:36 +02:00
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
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
65841ea20c
Merge pull request #6917 from albert-github/feature/bug_Polynomial_formula
...
Polynomial: background of formula in advanced section
2022-10-13 15:17:46 +02:00
532675a007
Merge pull request #6919 from albert-github/feature/bug_Polynomial_formula_2
...
Polynomial: replace images with formulas
2022-10-07 15:46:40 +02:00
3d4f748eb0
Update Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h
...
Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
2022-10-01 09:54:59 +02:00
7fac58c6b3
Update Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h
...
Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
2022-10-01 09:54:51 +02:00
7c69e8c1e6
Polynomial: replace images with formulas
...
Replace images that represent a formula with a proper formula.
See:
- Polynomial/classPolynomialTraits__d_1_1PolynomialSubresultants.html
- Polynomial/classPolynomialTraits__d_1_1SturmHabichtSequence.html
- Polynomial/classPolynomialTraits__d_1_1Resultant.html
2022-09-30 18:01:40 +02:00
26f6eb5b07
Polynomial: background of formula in advanced section
...
In the file `Polynomial/group__PkgPolynomialFunctions.html#ga0148f1612807b08b433f96c3ce07f2be` we see for the function `number_of_real_roots` in the advanced section that all formulas except 1 are nicely shown as (MathJax) formulas and that one is an image of which the background color is incorrect.
Replacing the image with a proper formula makes all consistent and proper.
2022-09-30 14:51:31 +02:00
18943fd955
Polynomial: Spurious backslashes
...
In the file Polynomial/doc/Polynomial/CGAL/Polynomial.h we see some spurious backslashes resultin in the file Polynomial/classCGAL_1_1Polynomial.html in:
```
The template argument Coeff must be at least a model of IntegralDomainWithoutDivision. For all operations naturally involving division, an IntegralDomain is required. Polynomial offers a full set of algebraic operators, i.e.\ binary +, -, *, / as well as +=, -=, *=, /=; not only for polynomials but also for a polynomial and a number of the coefficient type. (The / operator must only be used for integral divisions, i.e.\ those with remainder zero.) The operations are implemented naively: + and - need a number of Coeff operations which is linear in the degree while * is quadratic. Unary + and - and (in)equality ==, != are provided as well.
```
2022-09-28 12:22:11 +02:00
461dba692d
Documentation update in respect to code fragments
...
Update of documentation in respect of code fragments
- making code fragments work in footnotes
- placing some words in in code tags
- completing some words to code tags
- removing some `#` as they are not necessary
- don't show obfuscation code in email
2022-04-21 17:56:14 +02:00
a76bd6081e
Replace more sc text
2021-05-21 15:45:50 +02:00
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
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
590612a563
run the script to remove tabs and trailing whitespaces
2020-03-26 13:25:16 +01:00
fbafb9d06f
fix remaining mismatches and fix bugs
2019-07-10 11:40:45 +02:00
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
e4cbae525c
Merge remote-tracking branch 'cgal/releases/CGAL-4.13-branch' into HEAD
2019-01-31 11:25:26 +01:00
829c412b10
move note outside the brief
2019-01-14 17:53:40 +01:00
ea240cfac5
use \PkgXXX instead of \PkgXXXSummary
2018-10-08 10:28:44 +02:00
a2e8a1c68f
add the suffix Ref to doxygen link to reference
2018-10-08 10:26:56 +02:00
19adf3b05e
make the doc match struct/class with the implementation
2017-11-17 11:34:55 +01:00
0a04a3a48f
Use CGAL_DOC_VERSION
2016-02-11 15:37:54 +01:00
71b4e9c515
Use CGAL_FULL_VERSION in all Doxyfile.in
2015-12-17 16:33:28 +01:00
81a8f982dc
Handle the easy INPUT cases
...
If INPUT is just PKG/doc/PKG, handle it automatically.
2015-12-10 17:00:26 +01:00
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
9c2f35ed1a
using cgalHeading instead of h3
2013-08-07 10:06:49 +02:00
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
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
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
143a2181b3
add latex format for \imagei doxygen command
...
perl -pe 's/^(\s*)\\image\s+html\s+(.*)\s*$/$1\\image html $2\n$1\\image latex $2\n/' -i
2013-07-25 11:50:53 +02:00
519b301130
remove gif files from doxygen doc include path
2013-07-25 11:14:16 +02:00
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
716f87d2d7
rename Hidden_type to unspecified_type and update its description
2013-06-13 18:48:58 +02:00
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
4d469821f7
Generated Doxyfile.in and dependencies
2013-05-30 14:13:47 +02:00
7e15467c72
new cgal doxygen advanced macro to put the text inside a div
2013-05-27 19:36:33 +02:00
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
e991fe72ad
really add last missing classified reference manual pages
2013-03-13 10:57:01 +01:00
b0cffa4c7f
ExponentVector is no BackInsertionSequence
2013-03-04 16:38:30 +01:00
f2d0cc34cd
add implementation note in template alias declaration
2013-01-24 11:24:40 +01:00
35c64e2f46
using template alias declaration to inline a nested class
2013-01-24 08:27:33 +01:00
6e63d3cfa8
adding missing () in see also for functions
2013-01-09 19:48:42 +01:00
ade462dbad
add () to function reference in classified ref man
2013-01-08 17:50:33 +01:00
e313ce4397
using backticks to link in see also
2013-01-08 17:50:29 +01:00
Laurent Rineau
Andreas Fabri
albert-github
Maxime Gimeno
Sébastien Loriot
Philipp Möller
Ross Hemsley
Philipp Möller
Alexandros Konstantinakis-Karmis