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

62 Commits

Author SHA1 Message Date
Andreas Fabri e254a770df Some Fixes for #3457 2019-03-19 19:20:40 +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 18c677e441 Merge remote-tracking branch 'cgal/releases/CGAL-4.13-branch' 2019-01-02 10:23:31 +01:00
Sébastien Loriot 04b0a2c48a doc clean-up 
improve doxygen likeliness
 2018-12-31 08:15:28 +01:00
Laurent Rineau aeec7703f1 Merge pull request #3523 from albert-github/feature/bug_formula_errors 
Problems with formulas in documentation
 2018-12-19 16:08:12 +01:00
Laurent Rineau e4461a9057 Merge pull request #3543 from sloriot/Doc-multiple_fixes 
Remove duplicate definition
 2018-12-19 16:01:10 +01:00
Sébastien Loriot 57fd9818c7 exclude fig_src from being parsed 2018-12-14 07:53:01 +01:00
albert-github d6f878f361 Problems with formulas in documentation 
Small regression (substitution should not have taken place).
 2018-12-09 19:08:51 +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 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 97f8a6be17 move presentation files to fig_src (automatically excluded from a release) 2016-10-06 09:53:34 +02: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
Maxime Gimeno 7b4267c162 Replacement of cgalRequires 
-fix for #291
 2015-11-23 22:06: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
Andreas Fabri 5c84eaa6f8 Approved by the release manager 2013-10-17 14:42:55 +02:00
Andreas Fabri f9ab7a2ad5 \sa in a concept for a class must be prefixed with CGAL:: 2013-10-17 14:40:25 +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
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 08c9214275 doc: last replacements of \R by \mathbb{R} 2013-07-11 07:29:53 +02:00
Sébastien Loriot e3bdde7054 remove explicit reference to a header file 2013-06-17 09:52:08 +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 e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Sébastien Loriot 0454325193 doxygen doc fix: remove remaining \ccc 2013-03-07 12:26:41 +01:00
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Sébastien Loriot ade462dbad add () to function reference in classified ref man 2013-01-08 17:50:33 +01:00
Sébastien Loriot d2b9952e0b add classified ref man for QP_Solver 
This is duplicating information from module, but it's up
to the maintainer to decide.
 2013-01-07 15:52:34 +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 9a1862f74c polish QP Solver 2012-11-23 11:44:37 +01:00
Sébastien Loriot ae8362b7d6 replace \cgalModels ::FOO by \cgalModels `FOO` 
using:
 perl  -pi -e 's/\\cgalModels\s+::([A-Za-z0-9_:]+)\s*$/\\cgalModels `$1`\n/'
 2012-11-23 09:37:53 +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 0e2b61845c replace markup #, ##, ### by \section, \subsection and \subsubsection 
(manual replacement)
 2012-11-06 22:24:02 +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 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Andreas Fabri 59877a8d52 linking and unlinking 2012-10-30 13:40:03 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 2bd834f5af typo 2012-10-04 16:07:02 +00:00
Philipp Möller 63a820740d missing space. 2012-10-03 17:36:11 +00:00