Commit Graph

57 Commits

Author SHA1 Message Date
Laurent Rineau ffa852abe4 Fix scripts/index_fix, so that it works also on LaTeX document with
documentclass=article (instead of book).
2010-08-31 23:49:26 +00:00
Laurent Saboret c76930c46a generate_reference_manual version 1.3.1:
* Fixed incompatibility with variants of grep that do not support -P option (e.g. MacOS X)
* Fixed bug when processing "&&" string
* Fixed bug when a template class nested type is declared with template keyword
* Fixed bug in @commentheading
* Fixed bug in parameters parsing
* Fixed template declaration of nested template classes in \ccParameters section
* In the \ccParameters section, template parameters are now on a unique line to workaround a bug with typedef parameters types
* Added support of `' and '''' to emphasize words (besides "")
2010-06-20 17:41:44 +00:00
Sébastien Loriot d53e01f1a1 remove package namespace macro 2010-06-09 08:45:58 +00:00
Nico Kruithof 922cd70e79 More fixes for the doxygen2doc generator: operator-\/ replacement to operator- 2010-03-16 11:04:04 +00:00
Nico Kruithof 880ebfda08 Fixed a mismatch of nested brackets in the documentation generation tools from doxygen comments. 2010-03-13 09:01:18 +00:00
Sylvain Pion 4658a68630 2 fixes : differentiate between \ccCreation / \ccCreationVariable,
compatibility with doxygen 1.5.6 \paragraph[] instead of \paragraph[{}].
2009-09-09 10:37:04 +00:00
Sylvain Pion 6abc4f2b7f CGALi replaced by internal. 2009-08-24 17:11:26 +00:00
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
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 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 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
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
Laurent Saboret cb7532d93f Version 1.0.3: Fixed declaration of templated methods 2008-09-30 14:33:42 +00:00
Samuel Hornus 153ceb6c26 Added @commentheading keyword 2008-06-20 15:33:49 +00:00
Laurent Saboret af5184b550 Fixed bug in keep_only_if_function() 2008-06-02 17:04:55 +00:00
Laurent Saboret eb9eca14de Version 1.0.2:
- The tool does not display doxygen warnings by default. Use --verbose to have them back.
- \ccInclude, \ccRefine and \ccInheritsFrom commands are extracted from source code.
- Fixed bug when using @related doxygen keywords.
- Fixed bug in removal of cc_ref_wizard placeholder text.
2008-04-04 16:28:36 +00:00
Laurent Saboret 6e827c390e Fixed bug when skipping other definitions of namespaceXXX.tex 2008-04-01 17:37:07 +00:00
Laurent Saboret 34873c05a6 Port to Doxygen 1.5.5 2008-03-21 14:36:41 +00:00
Laurent Saboret bce59d7743 Version 1.0.1:
- Support templates nested in CGAL template.
- Turned on doxygen preprocessor.
2008-03-07 13:43:21 +00:00
Laurent Saboret ef10ca7e16 Bug fix: process all tex files in doc_tex/*_ref/ 2008-03-05 16:52:04 +00:00
Laurent Saboret 6f41a13ce2 Fixed bug when '@heading Parameters' occurs several times in the same file 2008-03-05 15:12:00 +00:00
Laurent Saboret 826c5677a9 Version 1.0:
- Complete rewrite of the code that extracts new CGAL Manual sections from C++ comments. It uses the new keyword @heading ans is much more generic and robust.
- New keyword @subheading keyword to define a sub-section in CGAL Manual.
2008-02-22 12:55:24 +00:00
Laurent Saboret d64885d524 Improved \ccHasModels parsing 2008-02-20 14:36:52 +00:00
Laurent Saboret 8b1a04b01c Fixed \ccVariables support 2008-02-20 11:46:58 +00:00
Laurent Saboret 743bd6ae88 Remove the placeholder text generated by cc_ref_wizard 2008-02-19 14:15:32 +00:00
Laurent Saboret ef646fd1f9 Words surrounded by simple quotes are emphasized using \ccc 2008-02-18 18:39:17 +00:00
Laurent Saboret 8704390c67 Version 0.9:
- more robust parsing
- removed option --force
2008-02-15 17:59:26 +00:00
Laurent Saboret 1771d4abb1 Updated usage and read-me 2008-01-31 16:13:00 +00:00
Laurent Saboret c7bd5e563c Turn off doxygen preprocessor 2008-01-25 17:38:39 +00:00
Laurent Saboret 647185134f Better progression message 2008-01-25 16:49:44 +00:00
Laurent Saboret 8bd79a18e2 generate_reference_manual version 0.8: compatible with doxygen 1.4 up to 1.5.4 2008-01-25 16:27:37 +00:00
Laurent Saboret 6c10de0cac Version 0.7.5:
- added support of constants in classes and concepts
- added label to virtual and protected members
2007-09-07 15:35:56 +00:00
Andreas Meyer 58944630a6 * tex2doxy now automatically creates required doxygen and html
documentation
* more matches between tex and doxy
2007-03-21 12:45:46 +00:00
Andreas Meyer 8271c9fa95 tex2doxy: added
* logging with verbosity levels
  * cmdline parsing (doxy and tex xml filenames)
2007-02-27 22:53:21 +00:00
Andreas Meyer 46f90ca21a tex2doxy: normalize function names even more. substitute
template parameters by $0...n to work around different spellings
(like ForwardIter and ForwardIterator).
2007-02-26 00:42:52 +00:00
Andreas Meyer 8c972cf9b6 now tex2doxy is immune against different spellings in
doc_tex and actual code (regarding function parameters). 
before comparing declaration-strings, they are normalized:
 * variable names and default values are eliminated
 * spaces are compressed/removed
 * function argument types can be (nested) template parameters, 
   pointers and arrays (not mixed with "(" and ")", however)
2007-02-25 20:38:57 +00:00