Sébastien Loriot
117b7cdf04
remove advanced in the brief of a concept
2019-02-13 19:06:26 +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
Guillaume Damiand
8a0dc2f279
Add one draw example in each user manual.
2018-05-29 11:11:49 +02:00
Guillaume Damiand
23426e70c4
Remove macro modified.
2018-05-29 11:11:49 +02:00
Guillaume Damiand
202781aa93
The -> the
2018-05-29 11:06:07 +02:00
Guillaume Damiand
381d09104a
Small update of LCC doc, following Andreas remarks.
2018-05-29 11:06:07 +02:00
Guillaume Damiand
a251b3a0cd
Rename file for basic viewers.
2018-05-29 11:06:07 +02:00
Guillaume Damiand
82179b45a4
Some more replace of display by draw; for lcc basic viewer.
2018-05-29 11:06:07 +02:00
Guillaume Damiand
d1bce718f9
Rename display into draw (for basic viewers)
2018-05-29 11:06:07 +02:00
Guillaume Damiand
69aa5d2188
Update user manual of LCC following Andreas comments.
2018-05-29 11:06:07 +02:00
Guillaume Damiand
aaf0c578f0
Document in doxygen the new display function for LCC.
2018-05-29 11:02:00 +02:00
Sébastien Loriot
f6459368aa
move fig_src dirs
2018-01-08 20:35:40 +01:00
Sébastien Loriot
19adf3b05e
make the doc match struct/class with the implementation
2017-11-17 11:34:55 +01:00
Guillaume Damiand
c8250c4570
Merge branch 'master' into BGL-LCC-gdamiand
2017-06-15 10:03:53 -04:00
Guillaume Damiand
f8fba47ac5
Remove cgalModif in doc
2017-06-15 09:47:30 -04:00
Laurent Rineau
4325f22314
Merge pull request #2145 from gdamiand/patch-1
...
Bug fix in doc
2017-06-12 11:51:33 +02:00
Guillaume Damiand
dba7e36944
Bug fix in doc of Linear cell complex
2017-05-31 17:35:43 -04:00
Guillaume Damiand
08578afb7c
Bug fix in doc
2017-05-31 17:30:51 -04:00
Guillaume Damiand
1bb0a3dda3
Document class Cell_attribute_with_point_and_id
2017-05-10 08:24:40 -04:00
Guillaume Damiand
42a1419dbf
Document class Cell_attribute_with_id
2017-05-10 08:22:22 -04:00
Sébastien Loriot
aec5d6a60c
clean up after rebase
2016-11-29 11:43:47 +01:00
Guillaume Damiand
8f07f91fa8
Remove red text in LCC doc; that was used for reviewing process.
2016-11-29 11:43:42 +01:00
Guillaume Damiand
bbf4bc8471
Update LCC test; use a smaller off file to speed up tests.
2016-11-29 11:43:39 +01:00
Guillaume Damiand
d6d6d27c93
Update LCC doc to follow the modification in examples.
2016-11-29 11:43:38 +01:00
Guillaume Damiand
57e4ff3abd
* replace CGAL_CMAP_DEPRECATED macro by CGAL_CMAP_DART_DEPRECATED
...
* protect deprecated code with #ifndef CGAL_NO_DEPRECATED_CODE
2016-11-29 11:43:33 +01:00
Guillaume Damiand
2aff4068b5
Allow to not define Dart_info and Attributes type in item class.
2016-11-29 11:43:32 +01:00
Guillaume Damiand
676b547a93
Doc of CMap, GMap and LCC is now ok for rev 4
2016-11-29 11:43:31 +01:00
Guillaume Damiand
d277576b15
Keep deprecated classes in the doc.
2016-11-29 11:43:31 +01:00
Guillaume Damiand
268036a088
Keep old names in the doc, marked deprecated.
2016-11-29 11:43:30 +01:00
Guillaume Damiand
74b5316bde
Update name in fig
2016-11-29 11:43:30 +01:00
Guillaume Damiand
bd805cd44f
Modif doc CMap, GMap, LCC
2016-11-29 11:43:28 +01:00
Guillaume Damiand
d0539bbd5b
Doc for CMap, GMap and LCC ok after review 2
2016-11-29 11:43:28 +01:00
Guillaume Damiand
954c7c2800
Doc CMap, GMap, LCC
2016-11-29 11:43:27 +01:00
Guillaume Damiand
c88fd4fd1c
Corrections following Sebastien review (nyf)
2016-11-29 11:43:26 +01:00
Guillaume Damiand
12f8efdba0
Typo
2016-11-29 11:43:26 +01:00
Guillaume Damiand
20979072cb
Small modifs following Sebastien review.
2016-11-29 11:43:26 +01:00
Guillaume Damiand
288313128e
End of doc for LCC.
2016-11-29 11:43:25 +01:00
Guillaume Damiand
c660599bed
Add a missing link
2016-11-29 11:43:24 +01:00
Guillaume Damiand
52266f5f82
Ok for LCC doc
2016-11-29 11:43:24 +01:00
Guillaume Damiand
c1ff5763f6
Continue doc of LCC
2016-11-29 11:43:22 +01:00
Guillaume Damiand
101700a2e0
Add figures for GMap doc
2016-11-29 11:43:22 +01:00
Guillaume Damiand
de634dbd87
Doc of GMap and LCC.
2016-11-29 11:43:21 +01:00
Guillaume Damiand
7e3cb2094e
Update also LCC doc accordingly.
2016-11-29 11:43:21 +01:00
Guillaume Damiand
8670c7b150
Update doc of LCC and figures.
2016-11-29 11:43:17 +01:00
Guillaume Damiand
fce9c1db1c
Cleanup figures in LCC.
2016-11-29 11:43:10 +01:00
Guillaume Damiand
79febdd8a3
All figures of CMap and LCC are now in svg.
2016-11-29 11:43:00 +01:00
Laurent Rineau
3044d512f2
Merge pull request #1511 from gdamiand/CMap_LCC-bugfixes-gdamiand
...
Some bugfixes in CMap and LCC
2016-10-17 10:01:36 +02:00
Sébastien Loriot
6ff846a483
add missing CGAL namespace
2016-10-11 15:21:09 +02:00
Guillaume Damiand
7620635cfe
* Bugfix in correct_invalid_attributes in LCC
...
* Remove deprecated code in LCC (that should be removed for CGAL 4.9)
2016-10-06 08:19:04 -04:00
Andreas Fabri
cf8c1a6cdf
Dispatch import functions to Polyhedron, T2, T3
2016-09-30 15:23:15 +02:00
Philipp Möller
0a04a3a48f
Use CGAL_DOC_VERSION
2016-02-11 15:37:54 +01:00
Sébastien Loriot
72863bfe44
fix doxygen warnings
2016-02-04 21:19:36 +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
Guillaume Damiand
4d6a8573f5
Add one example.
2015-01-06 12:24:50 +01:00
Guillaume Damiand
31f97645d9
Finalize doc + example.
2015-01-05 18:37:50 +01:00
Guillaume Damiand
bdc0dee6ce
Update operations to use are_attributes_automatically_managed
2014-12-23 22:15:49 +01:00
Guillaume Damiand
0860cf5012
Remove trailing whitespaces
2014-12-23 21:52:15 +01:00
Guillaume Damiand
c9345af46b
add the new function in Linear cell complex class.
2014-12-23 21:51:04 +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
Guillaume Damiand
8e8ab82527
Merge branch 'CMap_no_static_for_null_dart_handle-gdamiand'
...
null_dart_handle is no longer static; implies to move several methods from Dart concept into CMap concept. This will simplify the changing of the underlying container in the near future.
Small feature Combinatorial map dart attribute pre-approved in May 2013.
Approved by the release manager.
2013-11-28 08:22:40 +01:00
Guillaume Damiand
60e9c235af
typo
2013-11-26 17:29:31 +01:00
Guillaume Damiand
e42f41a615
Small modif in explanations of modifications.
2013-11-22 08:00:00 +01:00
Guillaume Damiand
db7c14cc58
* Document the deprecated function in Dart, CMap concept and LCC class;
...
* Add paragraph in changes.html;
* Bugfix in Linear_cell_complex_constructors for lcc without 2-attributes.
2013-11-21 10:23:24 +01:00
Guillaume Damiand
c34014bcf7
Doc update.
2013-11-19 16:31:53 +01:00
Sébastien Loriot
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
Sébastien Loriot
74a1ac055e
remove pdf files from doxygen doc include path
2013-07-25 11:15:18 +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
7e15467c72
new cgal doxygen advanced macro to put the text inside a div
2013-05-27 19:36:33 +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
890b02ead6
add last missing classified reference manual
2013-03-12 18:46:37 +01:00
Guillaume Damiand
b1d65019c1
Doxygen LCC ok.
2013-03-01 16:30:48 +01:00
Guillaume Damiand
f38df827b6
LCC doc, ok for concepts.
2013-03-01 14:29:38 +01:00
Guillaume Damiand
2a04b964cd
* More links in CMap doc.
...
* Add tag in doxyassist for LCC.
* Ok for LCC user manual.
2013-03-01 13:45:52 +01:00
Guillaume Damiand
2c4950eff3
Figures for LCC doc.
2013-03-01 11:15:27 +01:00
Guillaume Damiand
8734f2cf51
Doxygen version of the CMap doc.
2013-02-28 17:19:11 +01:00
Sébastien Loriot
26fa06bcfe
remove namespace in inheritance relationship
...
this produces a empty page to document it in doxygen
2013-01-23 16:28:37 +01:00
Sébastien Loriot
8f839f91ae
add missing space after $.
2013-01-23 14:58:03 +01:00
Sébastien Loriot
8fb18e7e63
fix linking warning and fix bug in naming
2013-01-18 17:48:27 +01:00
Sébastien Loriot
17bf812365
remove warnings in doxygen doc for Linear Cell Complex
2013-01-18 17:43:55 +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
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
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
0f69c2a512
remove cpp0x namespace from documentation pages
2012-11-14 16:16:15 +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
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
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
Philipp Möller
6615bcee09
Fix some minor glitches in headings
2012-10-18 12:55:17 +00:00
Andreas Fabri
b8b7a5dad3
get rid of spurious XX
2012-10-03 17:02:54 +00:00
Philipp Möller
bc48dfe5a0
Be consistent about author/authors
2012-10-03 16:40:16 +00:00
Andreas Fabri
16992d9713
change link for \ccDepends
2012-10-03 11:00:43 +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