Commit Graph

302 Commits

Author SHA1 Message Date
Laurent Saboret 3b12ebe45a * Fixed bug: 'type*' and 'type&' are not converted to \ccc{type*} and \ccc{type&}.
* Fixed bug: in class A, expressions with 2 levels of template like A<B<C>> are nor properly parsed.
-This line, and those below, will be ignored--

M    copy_doxygen_latex_doc
2009-06-17 07:38:44 +00:00
Laurent Saboret bd99461796 generate_reference_manual 1.3:
* Fixed bug #7515: removed "[protected]", "[static]" and "[virtual]" comments.

* Fixed bug: does not remove anymore EOLs in methods/functions description.

* Fixed bug: fixed vertical alignment in methods/functions description.

* Reduced left margin of free functions description.
Note: has to be done manually on classes/structs/concepts to get a pretty alignment of types, constructors and methods.
2009-06-11 07:53:24 +00:00
Laurent Saboret d2d7321ef2 Replaced temporay hack in generate_reference_manual r49560:
Use [A-Z][a-z]+[A-Z]\w* regex to match concepts names and wrap them by \ccc{}.
2009-05-27 13:10:10 +00:00
Laurent Saboret d3654328ed New options:
* -Ixxx to indicate the include path (no space)
* subfolder to parse
2009-05-26 16:46:52 +00:00
Laurent Saboret 78dcb5c219 * Workaround bug in cgal_manual: call \ccTagFullDeclarations at the beginning of \ccOperations.
This forces cgal_manual to expand const keyword are avoids 2 problems:
- bad keywords in HTML
- const and non-const methods seem identical.

* Also fixed a bug in copy_doxygen_latex_doc r49560:
cgal_manual compilation error on mst_orient_normals.tex.
2009-05-25 14:31:23 +00:00
Laurent Saboret e53b592e19 TEMPORARY: a few concept names are hard-coded in copy_doxygen_latex_doc until I find a better implementation:
PolylineSimplificationCostFunction
PolylineSimplificationStopPredicate
PolylineSimplificationVertex
ImplicitFunction
InputIterator
OutputIterator
ForwardIterator
2009-05-25 12:52:45 +00:00
Laurent Saboret 8ddfeb809b generate_reference_manual must be launched from doc_tex folder 2009-05-25 10:28:43 +00:00
Laurent Saboret f0e8548a13 * Fixed bug: generate_reference_manual does not fill \ccInclude macro if it not already present if a .tex file.
* Doxygen skips headers in subfolders named internal or CGALi. Doxygen skips namespaces named internal or CGALi.
* Doxygen #defines CGAL_DOCUMENTATION.
-This line, and those below, will be ignored--

M    generate_reference_manual/generate_reference_manual_Doxyfile
M    generate_reference_manual/copy_doxygen_latex_doc
2009-05-20 07:52:24 +00:00
Sylvain Pion 6418e3fe36 Undo last commit, it has side-effects by preventing automatic linking in
some other example programs.
2009-05-05 08:11:32 +00:00
Sylvain Pion f4137410aa </a> -> </A>.
It appears to fix a bug in an example in the kernel manual (fix by Marc Glisse).
2009-05-05 08:07:13 +00:00
Laurent Saboret d1a3275852 TEMPORARY HACK: close \ccEnum curly brace before enum list to workaround a bug in cgal_manual when compiling Surface_reconstruction_points_3 reference manual 2009-04-20 16:53:08 +00:00
Laurent Saboret 9d296b18bb * Fixed bug which printed a "Cannot add section \ccInclude" warning for concepts whose fake C++ class is in include/CGAL/.
* Fixed "INTERNAL ERROR: cannot extract template parameters" bug for templated methods returning a sub-type of the documented class".
* Removed "Class_name<...>::" prefixes for sub-types of the documented class" (prettier).
2009-04-20 10:47:35 +00:00
Laurent Rineau 432b61d506 Fix a bug I introduced in \ccc.
Thanks to Nicolas George and Arthur Ripoll (from "Forum", a community of
former students of ENS Paris) that have helped me understand more TeX
internals!
2009-04-17 09:54:57 +00:00
Laurent Rineau d1c79aced2 Add png files (converted from eps using 'convert') so that we can compile
with PDFLaTeX.
2009-04-17 09:52:14 +00:00
Laurent Saboret 9b62e1bb9d generate_reference_manual version 1.2:
- Fixed bug #7654: Incorrect generate_reference_manual output with doxygen >= 1.5.7
- Moved documentation to https://cgal.geometryfactory.com/CGAL/Members/wiki/Tools/generate_reference_manual.
2009-04-16 14:37:48 +00:00
Laurent Saboret 977526876a - Fixed bug n Template Parameters formatting introduced in r48735.
- Increment version number to 1.1.2.
2009-04-09 12:48:39 +00:00
Laurent Saboret ed38b56d71 Fixed bug in enumerations documentation. 2009-04-09 12:35:18 +00:00
Laurent Saboret 64c52be8d2 Fixed error messages when Reference manual is empty (no .tex files). 2009-04-09 09:50:36 +00:00
Laurent Saboret 452efbf161 * Fixed rare bug where Doxygen did not expand CGAL_BEGIN/END_NAMESPACE.
* Generate Doxygen XML output to get an index easy to parse (doxygen/xml/index.xml - unused yet).
2009-03-24 17:05:03 +00:00
Laurent Saboret 89da9d7c2e generate_reference_manual version 1.1.1:
* New features:
- Print short help when generate_reference_manual is called without parameters, long help when called with -h.
- Improved traces.

* Fixed bugs discovered when parsing Polyline_simplification_2:
- Check if package parameter exists.
- Fixed bug when parsing item name in a sub-namespace of CGAL::.
- Fixed case where default constructor was nor properly updated.
- Fixed bug in documentation of templated methods of a class.
- Added support of several include files for a class.
2009-03-23 14:46:07 +00:00
Laurent Saboret dba0e4e272 Try: prettier function/method output but the generated Latex is harder to read (commented out) 2009-03-13 17:08:29 +00:00
Laurent Saboret f4def26eb8 Define \itemsep for latex_to_html 2009-02-26 13:40:57 +00:00
Laurent Saboret 82143450e7 generate_reference_manual 1.1:
* Bug fixes:
- Document properly the template parameters of functions. No separate Parameters section.

* Improved formatting of functions and methods:
- Shorter latex code and shorter printed documentation
- Fixed indentation
- Parameter names are in italic instead of bold

* Words surrounded by stars are formatted in bold.
2009-02-26 11:02:59 +00:00
Sylvain Pion 7bd28c2218 Document \ccSum and \ccProd. 2009-02-02 18:08:50 +00:00
Sylvain Pion 80a962c21e New \ccProd. 2009-02-02 17:26:51 +00:00
Sylvain Pion 40200e96cf New \ccsum{a}{b}{c} macro that does \sum_{a}^{b}{c} with nicer html rendering. 2009-02-02 17:06:34 +00:00
Sylvain Pion f04ed5e4e7 Add comment. 2009-02-02 15:21:08 +00:00
Sylvain Pion 9d3827addb In the package overview page, replace
"BibTex Key: cgal:kqjshdfgbqlbchrlqcgalisgreatandmoniqueevenmorebutwhatsthisbibtexthingkjshbfliqsudgldfs"
by
"Citation Entry"
2009-01-31 17:43:37 +00:00
Sylvain Pion a6060ffd6c Fully CSS-ify the ccAdvanced environment, with a background image.
Also add images for Class, Concept, etc... (longer and thiner than the current
ones) to be used in a further commit.
2009-01-28 17:49:41 +00:00
Laurent Rineau 425aeb4621 Merge from branch 3.4:
r47778 | lrineau | 2009-01-22 11:14:13 +0100 (Thu, 22 Jan 2009) | 2 lines

Fix links to acknowledge.html

------------------------------------------------------------------------
r47776 | lrineau | 2009-01-22 11:06:06 +0100 (Thu, 22 Jan 2009) | 2 lines

Fix a link in how_to_cite_cgal.html
2009-01-22 10:16:48 +00:00
Laurent Rineau dc5d2dc434 Remove \cccWithURL and \ccRefIdfierPageWithURL 2009-01-20 22:50:19 +00:00
Laurent Rineau 89908df679 \ccc and \ccRefIdfierPage now have an optional argument. Usage:
\ccc[Kernel::do_intersect]{void do_intersect(int a, int b)}
  \ccRefIdfierPage[Kernel::do_intersect]{do_intersect}

The argument must be a label declared with \ccRefLabel, such as in:
  \ccRefLabel{Kernel::do_intersect}
2009-01-20 21:56:43 +00:00
Laurent Rineau e68504513a ooops. If the *second* argument is to be ignored, then only the *first one*
should be passed.
2009-01-20 14:02:56 +00:00
Laurent Rineau cbacb441a1 Add a wrapper \ccRefIdfierPageWithURL. 2009-01-20 12:41:25 +00:00
Laurent Rineau 554e9dabb6 revert revision r47751 2009-01-20 12:39:24 +00:00
Laurent Rineau 79579c66a6 Add generated files to svn:ignore. 2009-01-20 12:36:38 +00:00
Sylvain Pion 015ed74b19 In the navigation bars, replace the underlying and overlying <hr>,
by a nicer and cleaner CSS equivalent (solid thin border).
2009-01-17 13:39:09 +00:00
Sylvain Pion ea6842b766 Title Page -> Title (in the navigation bar) 2009-01-17 10:12:14 +00:00
Sylvain Pion 659a7bae1f Minor improvements to the navigation bar, and use a meta tag. 2009-01-17 09:59:33 +00:00
Laurent Rineau 54aabfe8c2 Revert the following revision, because it leads to many many warnings!
r47695 | lrineau | 2009-01-08 16:53:03 +0100 (Thu 08 Jan 2009) | 2 lines

Output a warning when two or more anchor rules have the same key.
2009-01-09 10:29:14 +00:00
Laurent Rineau bcec6c9d30 Add a wrapper around \ccc so that one can chose the URL of the HTML link,
instead of the automatic one.
In LaTeX mode, that macro ignores its second argument.

That macro is named \cccWithURL{}{}.
2009-01-09 10:16:54 +00:00
Sylvain Pion fceb87e931 Update comments after last change, and fix thinko. 2009-01-09 09:40:03 +00:00
Sylvain Pion 8727946a30 Simplify treatment of \textsc, since it's trivial to do with a CSS :-). 2009-01-08 23:39:16 +00:00
Laurent Rineau f4109fab64 Output a warning when two or more anchor rules have the same key. 2009-01-08 15:53:03 +00:00
Laurent Saboret 9ec9192f57 Added hack to reference the next papers:
- Poisson Surface Reconstruction [Kazhdan06]   
- Algebraic point set surfaces [Guennebaud07]
- Surface Reconstruction From Unorganized Points [Hoppe92]
2009-01-08 14:17:59 +00:00
Sylvain Pion e82f1490b7 Justify text globally (isn't it nicer?). 2009-01-06 17:19:20 +00:00
Sylvain Pion 7c945fe101 \mathcal does not need char-by-char treatment anymore. 2009-01-06 16:55:37 +00:00
Sylvain Pion 34b5d5f978 bigbig font seems too big (hard to guess right in HTML). 2009-01-06 15:56:59 +00:00
Sylvain Pion 2b851a2517 array : remove VALIGN=TOP (why was it there?), and add more cellspacing. 2009-01-06 15:42:35 +00:00
Sylvain Pion 5b5913b4e4 Add missing class="math" in array. 2009-01-06 15:12:24 +00:00