Commit Graph

48 Commits

Author SHA1 Message Date
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 7a6aa123d7 add classified reference manual for Mesh_2 2013-03-12 13:36:15 +01:00
Sébastien Loriot 5ec28b1cf4 replacing the usage of section in user man by \cgalHeading macro call 2013-01-07 18:04:37 +01:00
Andreas Fabri 0ee845a9cc polish Mesh_2 2012-12-27 20:58:17 +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 9c79cb5c7f backport commit in tex file from master into doxygen 2012-11-23 18:16:59 +01:00
Andreas Fabri 3447d93aa2 typo 2012-11-23 11:46:13 +01:00
Andreas Fabri 8d3c6a9bb9 polish Mesh_2 2012-11-23 11:44:39 +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 2607d8b7b9 missing { and extra latex 2012-11-19 16:32:51 +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 6abaad0be3 No need for :: as prefix in backquotes 2012-10-31 20:52:33 +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
Laurent Rineau ac31600c60 Mesh_2 documentation verify by the author
Remove the \todo
2012-10-04 08:09:52 +00:00
Laurent Rineau b4ab505a42 Fix syntax
- de-LateXify the parameter names,
- avoid `quotes` on more than two lines.
2012-10-03 13:20:36 +00:00
Laurent Rineau c5ee6400c1 Use lists in the description of MeshingCriteria_2::Is_bad.
That is infinitely better than with the LaTeX manual tools!
2012-10-03 13:06:50 +00:00
Laurent Rineau 44d051d631 Uniformly s/SqrtFieldNumberType/FieldWithSqrt/g
SqrtFieldNumberType is no longer documented. (For how long?)

I have also rephrase "A `SqrtFieldNumberType`" to "A model of the
`SqrtFieldNumberType` concept", that sounds more correct.
2012-10-03 12:10:00 +00:00
Laurent Rineau d84e60c1f6 Typo in a return type 2012-10-03 12:04:17 +00:00
Andreas Fabri 16992d9713 change link for \ccDepends 2012-10-03 11:00:43 +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 9d96057636 Add PkgDependsOn to the package summary 2012-09-27 11:13:37 +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 e54098fb57 Throw out left over Classified files and move their content if
necessary.
2012-09-20 16:29:19 +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
Philipp Möller 1b3a78a08f Salvage the demo information from the old package description. 2012-09-20 13:30:49 +00:00
Andreas Fabri 6f61e2b2ee Downsize headings 2012-09-17 14:53:05 +00:00
Laurent Rineau 90820a8c50 Fix those warnings:
Mesh_2.txt:87: warning: unable to resolve reference to `Mesh_2/conforming.cpp' for \ref command
Mesh_2.txt:247: warning: unable to resolve reference to `Mesh_2/mesh_global.cpp' for \ref command
Mesh_2.txt:258: warning: unable to resolve reference to `Mesh_2/mesh_class.cpp' for \ref command
Mesh_2.txt:270: warning: unable to resolve reference to `Mesh_2/mesh_with_seeds.cpp' for \ref command
2012-08-30 15:11:40 +00:00
Laurent Rineau a03de5b89d Fix warnings 2012-08-30 14:58:56 +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 55611632bf link free functions by prefixing with :: 2012-08-29 13:47:40 +00:00
Andreas Fabri 1888469bda /</I> -> </I>; %Default 2012-08-29 08:54:08 +00:00
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Andreas Fabri 0e1f9b775f Put several small images side by side 2012-08-28 13:50:54 +00:00
Andreas Fabri dc33da0804 fix linking in \has Models by backquoting and prefixing with CGAL namespace 2012-08-27 09:05:23 +00:00
Andreas Fabri d2f647f8c6 \require -> \requires 2012-08-21 13:24:01 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +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 46999aaa09 Linking to Face_badness 2012-08-17 12:52:40 +00:00
Andreas Fabri db7971d0ec no whitespace before . 2012-08-17 11:59:41 +00:00
Philipp Möller c80da3b032 Use new layout 2012-08-16 17:12:26 +00:00
Philipp Möller 4a24b439f4 Layouting and package building changes
Fiddle with the master doxygen file, improve package overview
building, add a set of packages to the doxyassist XML, fix up
straggling packages that didn't have those changes
2012-08-08 09:21:40 +00:00
Philipp Möller ebe9072d1d Testwise STL_Extension + Mesh_2 2012-07-27 18:45:02 +00:00