songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
103,721 Commits 3 Branches 156 Tags 958 MiB
Commit Graph

45 Commits

Author SHA1 Message Date
Mael Rouxel-Labbé b5c21e1f5d Http -> https + update some dead links 2022-11-23 18:54:37 +01:00
Sébastien Loriot d191d4474a Revert "fix not documented warnings" 
This reverts commit 8d773c56348c4055d963c57426d60d118915d22b.
 2022-09-23 14:04:51 +02:00
Sébastien Loriot 6397378bdc fix not documented warnings 2022-09-23 13:29:40 +02:00
Sébastien Loriot d8f0bc4c08 dedicated macro for precondition 2022-09-21 09:42:32 +02:00
Sébastien Loriot 681120764e please the CI with a new macro 2022-09-21 09:36:41 +02:00
albert-github 939dfbe68a Documentation update in respect to code fragments 
- Corrected some another const and mutable based on review
- Corrected BaseDoxyfile.in for other builds of this (5.5) version
 2022-04-22 10:31:21 +02:00
Sébastien Loriot 10b0af3092 rename macro since Named_function_parameter is part of STL_Extension 2022-01-13 14:43:34 +01:00
Sébastien Loriot 9112001f33 fix doc 2022-01-06 19:11:54 +01:00
Sébastien Loriot 9714557046 replace overloads with default parameters (PMP) 2022-01-05 14:41:46 +01:00
Sébastien Loriot a6d9b99466 move macros in BaseDoxyfile 2022-01-04 11:10:09 +01:00
Laurent Rineau b9743fffa3 Merge pull request #5741 from danston/Solvers-add_osqp-danston 
[Small Feature] OSQP Support in Solver Interface
 2021-07-27 15:55:23 +02:00
Mael Rouxel-Labbé 78ff9185b3 Harmonize ASCII usage across all packages 2021-06-23 23:34:32 +02:00
Dmitry Anisimov 267a6412ac initial commit with the new osqp solver concept 2021-05-31 14:01:08 +02:00
Maxime Gimeno a76bd6081e Replace more sc text 2021-05-21 15:45:50 +02:00
Sébastien Loriot 72bc88d38f do not link in the macro 2021-04-08 18:28:24 +02:00
Maxime Gimeno fb3746168d remove \sc 2021-02-05 11:10:20 +01:00
Mael Rouxel-Labbé 038869cab9 Merge remote-tracking branch 'cgal/master' into CGAL-Improve_NP_doc_presentation-GF 2020-05-12 15:12:21 +02:00
albert-github 876aa4c0bd Introducing CMake option CGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY 
When (re)generating the documentation from the sources and not using the, internally patched CGAL, doxygen version one gets messages about:
```
warning: ignoring unsupported tag 'EXTRACT_ALL_NO_DETAILED_IF_EMPTY'
```

By introducing the option `CGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY` this doxygen setting can be steered
- option not supplied to cmake, will use as if specified  `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=ON`
- option supplied to cmake as `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=ON` will write the line `EXTRACT_ALL_NO_DETAILED_IF_EMPTY = YES` in the doxygen configuration
- option supplied to cmake as `-DCGAL_EXTRACT_ALL_NO_DETAILED_IF_EMPTY=OFF` will write the line `#EXTRACT_ALL_NO_DETAILED_IF_EMPTY = NO` in the doxygen configuration, so just using the default setting of `NO` line could be omitted but it is better to have a placeholder
 2020-04-27 13:12:33 +02:00
Sébastien Loriot 3b52dfd7de Merge remote-tracking branch 'cgal/master' 2020-04-18 14:47:28 +02:00
Mael Rouxel-Labbé f0532f9f31 Fix horizontal max width 2020-04-13 13:03:20 +02:00
albert-github e5177aa014 Introducing central MATHJAX_CODEFILE 
Currently the needed extra definitions for MathJax usage (i.e. `\newcommand` and `\def` commaonds) are distributed over the header file and in a number of source code files.
Doxygen has the possibility for a centralize this by means of the MATHJAX_CODEFILE configuration setting, this has been implemented.
 2020-04-13 12:37:57 +02:00
Mael Rouxel-Labbé 2337716bcd Merge remote-tracking branch 'cgal/master' into CGAL-Improve_NP_doc_presentation-GF 2020-04-12 20:46:35 +02:00
Sébastien Loriot 947c838a6c Merge remote-tracking branch 'cgal/releases/CGAL-4.14-branch' 2020-04-08 15:55:15 +02:00
Sébastien Loriot 75f0b18224 remove deprecated config options 2020-04-07 14:31:36 +02:00
Mael Rouxel-Labbé c1a15f8c02 Add NPBegin macro with an argument (for VSA) 2020-04-05 17:57:10 +02:00
Mael Rouxel-Labbé fc79510388 Regroup NP aliases into the base doxyfile.in 2020-04-04 17:26:32 +02:00
Andreas Fabri 6d4a431b18 polish 2019-10-25 10:18:41 +02:00
albert-github 1dd7473818 Correction of links 
Correction of redirected links and links that moved to another place.
 2019-04-11 21:37:05 +02:00
Laurent Rineau 60478dd816 Merge pull request #3758 from albert-github/feature/bug_advanced_2 
Correction of (X)HTML warnings in case of Advanced topics
 2019-03-19 18:30:53 +01:00
albert-github 28fdb2d425 Correction of (X)HTML warnings in case of Advanced topics 
Based on suggestion of @sloriot using `^^` also in cgalAdvancedEnd instead of adding a new line in the files
 2019-03-15 11:33:48 +01:00
Laurent Rineau e32637fa7c Merge pull request #3719 from albert-github/feature/bug_packages_html 
Invalid (X)HTML sequence
 2019-03-11 17:26:27 +01:00
albert-github 8b7f0bcb1e Correction of (X)HTML warnings in case of Advanced topics 
Based on #3713 a  number of problems were solved, but also some new issues introduced.
- BaseDoxyfile.h see to it that the CGALAdvancedBegin is in a detailed part, so be sure to terminate the brief part by an extra carriage return
- commands like \pre, \note read till the beginning of the next section but a \htmlonly is not seen as a section separator, so insert an extra carriage return
- some places  missed an "Advanced" indicator, used the cgalAdvancedType here.

##Note
in Periodic_2_triangulation_2.h there appear to be a number of images that are a bit in thin air (Captions: "Insertion of a point on an edge." and "Insertion in a face."). Also just above these images theer are a number of functions that have documentation, but this is non-doxygen documentation and as such not seen by doxygen
 2019-03-10 16:00:52 +01:00
Laurent Rineau f5836b2206 Merge branch 'releases/CGAL-4.13-branch' 2019-03-07 14:31:16 +01:00
Sébastien Loriot 3887a21429 add missing text for brief of advanced class/type/function/concept 2019-03-05 08:01:17 +01:00
Sébastien Loriot f058854904 rename macro + apply to all version config files 2019-03-04 08:57:10 +01:00
albert-github 2f3aeb7b9b Invalid (X)HTML sequence 
Based on the discussion an updated implementation dropping the post processing step in favor of a `<div style=..` implementation
 2019-02-28 19:29:49 +01:00
Sébastien Loriot 50a59c3096 add new macros to be used in classified reference manual 2019-02-14 10:27:26 +01:00
Laurent Rineau 772da33fd5 Merge pull request #3519 from albert-github/feature/bug_xhtml_toc 
XHTML problem regarding TOC definition
 2018-12-19 16:08:18 +01:00
Sébastien Loriot 7e42c30647 avoid extra `</p>` after figures 2018-12-12 08:24:32 +01:00
albert-github 8f9510c3a4 XHTML Problems regarding tag sequences 
XHTML is strict regarding tag sequences (contrary to HTML) in out case most of the times missing or superfluous p tags.
 2018-12-11 19:31:25 +01:00
albert-github 14560b8e3c XHTML problem regarding TOC definition 
Form the doxygen documentation:
Normally the contents between \htmlonly and \endhtmlonly is inserted as-is. When you want to insert a HTML
fragment that has block scope like a table or list which should appear outside <p>..</p>, this can lead to invalid
HTML. You can use \htmlonly[block] to make doxygen end the current paragraph and restart it after \endhtmlonly.
 2018-12-08 15:15:27 +01:00
Sébastien Loriot 01af331c72 use https for all links to www.cgal.org and doc.cgal.org 2018-03-14 15:59:38 +01:00
Sébastien Loriot 5e81643b53 let doxygen decide what is MATHJAX_RELPATH by default 2018-01-24 14:38:01 +01:00
Sébastien Loriot f10f072139 update config file of doxygen 1.8.14 2018-01-22 17:18:21 +01:00
Sébastien Loriot 85b4ad3271 restore 1.8.13 aliases and create new resource dir for 1.8.14 
aliases from 1.8.13 and 1.8.14 are not compatible with each other
 2018-01-22 17:05:03 +01:00