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

129 Commits

Author SHA1 Message Date
Michael Hemmer 8f18eb46f9 improve documentation of ImplicitInteroperable 2014-01-30 13:57:14 +01:00
Laurent Rineau 4d721b8969 Fix a typo: RealComparable/RealEmbeddable 2013-12-17 15:39:27 +01:00
Sébastien Loriot 21fe94a3f1 update group name in doc 
Approved by the release manager
 2013-10-04 17:35:31 +02:00
Andreas Fabri 50a4da2992 Put () after function names to increase readability 2013-08-28 15:14:25 +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 67a73344f3 fix linking issue 
fig bug #15486
 2013-07-25 13:58:48 +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
Sébastien Loriot 2ac05c6d95 fix warnings detected by doxygen 1.8.4 2013-05-24 12:49:02 +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 7e59c14580 add a header to classified reference pages using a doxygen macro 2013-03-12 14:33:49 +01:00
Sébastien Loriot 609925675b add a trailing _ to the namespaces of the concepts in Algebraic Foundations 
No more warning!
 2013-01-24 19:16:40 +01:00
Sébastien Loriot 3b81e2d1a4 fix warnings in algebraic foundations 
to fix the remaining warnings we need a strategy to disambiguate
the typedef vs. the concept
 2013-01-20 12:21:53 +01:00
Sébastien Loriot 6e63d3cfa8 adding missing () in see also for functions 2013-01-09 19:48:42 +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 5f3c8826d1 h2 is the first header in classified reference manuals 2013-01-07 09:00:48 +01:00
Sébastien Loriot 42d15a11d0 using uniform markups in classified reference pages 2013-01-04 15:16:40 +01:00
Philipp Möller 0b5021a461 Flatten the modules and integrate the Classified Reference 2012-12-18 22:09:21 +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
Sébastien Loriot 920eb63882 backporting documentation changes of master@9fcc5b57 into doxy-port-pmoeller 
Conflicts:
	Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h
	Installation/doc_tex/Installation/usage.tex
	Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h
	Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h
	Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h
 2012-11-23 22:54:31 +01:00
Sébastien Loriot 947f6352bc backport commit in tex file from master into doxygen 2012-11-23 15:29:38 +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 4fa2db4a48 change \sa ::FOO into \s `FOO` 
using:
perl  -pi -e 's/\\sa\s+::([A-Za-z0-9_:]+)\s*/\\sa `$1`\n/'
 2012-11-23 09:18:35 +01:00
Sébastien Loriot 936a94fc5e missing ref 2012-11-15 09:16:45 +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 974621b58f start using new figure macros. 
For Combinatorial maps, I reintroduced the original anchor names as they
were still in use in the reference manual.
 2012-11-08 10:55:09 +00:00
Sébastien Loriot ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection 
(script replacement)
 2012-11-06 22:02:15 +00:00
Sébastien Loriot 297ed62c30 decrease level 2012-11-06 20:50:00 +00:00
Sébastien Loriot 34d6728763 remove exe property 2012-11-06 15:54:42 +00:00
Andreas Fabri d981d9aadf typo 2012-11-02 10:59:50 +00:00
Andreas Fabri 7a6634b5a7 No need for CGAL:: in user manuals 2012-10-31 20:11:16 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 92e32a4f8a fix (old) linking problem 2012-10-15 09:53:30 +00:00
Andreas Fabri 5a8b3c2ea9 fix (old) linking problem 2012-10-15 07:22:45 +00:00
Philipp Möller b7ae09f4a6 Better linking to Tag_true 2012-10-12 13:25:24 +00:00
Andreas Fabri 5ef6b0d52e cleanup of classified reference pages; Move global functions in a group too 2012-10-10 13:33:03 +00:00
Andreas Fabri bdcb53abef Add a classified Reference page 2012-10-10 06:33:36 +00:00
Andreas Fabri 86f5f18679 linking 2012-10-05 13:18:58 +00:00
Andreas Fabri 63cec869c1 linking 2012-10-05 13:09:54 +00:00
Philipp Möller bc48dfe5a0 Be consistent about author/authors 2012-10-03 16:40:16 +00:00
Philipp Möller c9fdbf3edb Add an anchor to each level one heading, so we get a nice tree in the 
user manuals.
 2012-10-02 11:53:01 +00:00
Philipp Möller 37778547bf Fix example to point to paths similar to a flat layout 2012-10-01 18:02:44 +00:00
Philipp Möller a78c695347 Fix another doxygen bug and throw out another hack. 2012-09-27 17:07:10 +00:00
Philipp Möller 9d96057636 Add PkgDependsOn to the package summary 2012-09-27 11:13:37 +00:00
Philipp Möller 8162ba0ea1 move interval_nt_advanced to its true scope 2012-09-26 10:05:48 +00:00
Andreas Fabri eeeec9f768 link 2012-09-25 19:25:47 +00:00
Andreas Fabri 3fba305d28 link 2012-09-25 19:21:39 +00:00
Philipp Möller b64ba48134 The changes to move the package overview labels into the 
PackageDescription.
 2012-09-25 17:17:49 +00:00
Philipp Möller 1954eff3d6 * build normalized mainpage anchors 
* better naming for Pkg commands
* User and Reference Manual links from the PackageOverview
 2012-09-20 15:30:03 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Philipp Möller f3b773acb4 Add Surface_mesher doc 2012-09-17 13:12:18 +00:00
Philipp Möller 6b52a970b3 Remove leftover Classified file 2012-09-11 14:24:34 +00:00
Andreas Fabri 485f314463 grouping 2012-08-30 08:56:14 +00:00
Philipp Möller 2d8931167f autoexamples 2012-08-29 16:20:55 +00:00
Philipp Möller 5a0a5403c4 Enable autotoc on mainpages 2012-08-29 15:45:17 +00:00
Andreas Fabri 9f54f4360f fix i.e. and a.k.a. 2012-08-29 11:06:54 +00:00
Andreas Fabri 6f4d993dd7 grouping 2012-08-29 11:03:08 +00:00
Philipp Möller 1af50f6e96 Redo without grouping 2012-08-29 09:57:02 +00:00
Philipp Möller 2644d17f51 Temporary backup 2012-08-29 09:12:53 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Philipp Möller 4b07d25fbd Removed file that got accidentaly added. 2012-08-23 17:35:47 +00:00
Andreas Fabri 953750d80e lowercase 2012-08-23 14:27:05 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +00:00
Andreas Fabri 721c41f9c8 fix brief for e.g. and a.k.a. 2012-08-21 08:53:23 +00:00
Andreas Fabri 3dfd7031c2 Remove whitespace 2012-08-20 18:30:46 +00:00
Philipp Möller d3a9a641de Refurb package descriptions with a label for the license. 2012-08-20 14:28:36 +00:00
Philipp Möller c80da3b032 Use new layout 2012-08-16 17:12:26 +00:00
Philipp Möller 6a45864c1a Throw a set of ported doc files under version control 2012-08-09 16:07:44 +00:00
Philipp Möller 63c34025b2 * Fiddling with \hasModels and \refines. 
* Number_types package
 2012-06-13 14:29:48 +00:00
Philipp Möller d35457df3b Algebraic_foundations 2012-06-07 14:53:28 +00:00