Commit Graph

352 Commits

Author SHA1 Message Date
Andreas Fabri 71aed48848 cleanup 2015-04-02 14:08:18 +02:00
Andreas Fabri c50448e918 move SvdTraits 2015-03-30 08:51:12 +02:00
Andreas Fabri 83f1d1b29a move files 2015-03-25 08:57:00 +01:00
Andreas Fabri 0e94b47457 improve jet fitting manual 2015-03-13 10:32:06 +01:00
Sébastien Loriot b28b4607ae use UTF8 for letters with accent 2015-01-31 13:58:08 +01:00
Laurent Rineau 36d8b5bd18 Convert source files encoding to utf-8
All non-ASCII files should be encoded in UTF-8. So far, the ZSH script
`Scripts/developer_scripts/detect_wrong_encoding` detects wrong encoding
in source/header files of include/, src/, and doc/.
2014-08-01 11:20:13 +02: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
Sébastien Loriot b2b7e5cb7c bugfix to avoid assuming Monge_via_jet_fitting has default template parameters 2014-01-23 10:32:30 +01:00
Sébastien Loriot 0fa2cacb60 remove doc_tex documentation (including developer manual) and old manual tools 2013-12-03 17:27:02 +01:00
Andreas Fabri ed44821ba9 How did Cartesian.h sneak in again?? 2013-11-10 09:41:08 +01:00
Andreas Fabri d5f2a1d64d Switch from char* to std::string
This leads to more proper code, and we get rid of a memory leak more elegantly
2013-11-08 15:30:41 +01:00
Andreas Fabri 6c547e5663 Mainly added includes 2013-09-13 22:24:30 +02:00
Andreas Fabri 97d04b8f37 switch to Simple_cartesian 2013-09-05 10:56:15 +02:00
Laurent Rineau a601b7bc06 Remove a superfluous .cpp (also from the documentation)
Follow-up to the following commit:
  | commit d2f0eff3cb
  | Author: Andreas Fabri <andreas.fabri@geometryfactory.com>
  | Date:   Tue Aug 27 09:56:39 2013 +0200
  |
  |     Switch to Simple_cartesian.
  |     Remove a superfluous .cpp
  |     Reorder #includes
2013-08-29 11:16:54 +02:00
Andreas Fabri d2f0eff3cb Switch to Simple_cartesian.
Remove a superfluous .cpp
Reorder #includes
2013-08-27 09:56:39 +02:00
Laurent Rineau bc03aaf30b Put doc/ in the global dont_submit file 2013-08-20 10:57:03 +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 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
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
Andreas Fabri 876a4a5753 remove unused variables and #if 0 buggy non used code 2013-02-26 17:05:13 +01:00
Laurent Rineau 26a7e70785 New license.txt files (eol changes)
The new version 2.13.0 of licensecheck has changed the spaces at eol.
2013-02-19 16:46:39 +01:00
Sébastien Loriot 46e4ceead9 add concepts Matrix and Vector in SvdTraits to get nested types in SvdTraits
in the old documentation the concepts were inlined in the SvdTraits
2013-01-24 09:12:48 +01:00
Sébastien Loriot 6785665537 add missing reference 2013-01-04 16:09:20 +01:00
Andreas Fabri b71421e326 polish Jet_fitting 2012-12-28 19:58:05 +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 4ec9529581 Merge branch 'doxy-port-pmoeller'
Conflicts:
	.gitattributes
	Surface_reconstruction_points_3/include/CGAL/Poisson_reconstruction_function.h
	Surface_reconstruction_points_3/include/CGAL/Reconstruction_triangulation_3.h
	Surface_reconstruction_points_3/include/CGAL/k_nearest_neighbor.h
2012-11-27 10:05:41 +01:00
Sébastien Loriot 9576be3c3b add doc in dont_submit 2012-11-27 08:42:02 +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 7cd0e93fa9 Revert "Merge the changes to ccPrecond and ccPostcond that have been in"
This reverts commit b529971917.

Conflicts:
	Approximate_min_ellipsoid_d/doc_tex/Bounding_volumes_ref/Approximate_min_ellipsoid_d.tex
	Matrix_search/doc_tex/Polytope_distance_d_ref/spec_all_furthest_neighbors.tex
	Min_annulus_d/doc_tex/Bounding_volumes_ref/Min_annulus_d.tex
	Min_circle_2/doc_tex/Bounding_volumes_ref/Min_circle_2.tex
	Min_ellipse_2/doc_tex/Bounding_volumes_ref/Min_ellipse_2.tex
	Min_quadrilateral_2/doc_tex/Bounding_volumes_ref/spec_oops.tex
	Min_sphere_d/doc_tex/Bounding_volumes_ref/Min_sphere_d.tex
	Min_sphere_of_spheres_d/doc_tex/Bounding_volumes_ref/MinSphereOfSpheresTraits.tex
	Min_sphere_of_spheres_d/doc_tex/Bounding_volumes_ref/Min_sphere_of_spheres_d.tex
	Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Taucs_matrix.tex
	Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Taucs_symmetric_matrix.tex
	Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_triangulation_2.tex
	Width_3/doc_tex/Polytope_distance_d_ref/Width_3.tex
2012-11-23 18:04:33 +01:00
Sébastien Loriot 991561878f backport commit in tex file from master into doxygen 2012-11-23 17:54:48 +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 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 22cf2a9ed7 CGAL_EIGEN3_ENABLED now only controls the default.
The same now holds for CGAL_TAUCS_ENABLED and CGAL_LAPACK_ENABLED
2012-11-08 08:58:33 +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
Andreas Fabri 59877a8d52 linking and unlinking 2012-10-30 13:40:03 +00:00
Sébastien Loriot 82a9f8940c add depends 2012-10-19 17:19:13 +00:00
Sébastien Loriot 69d744b2ab merge from next and update doxygen doc 2012-10-19 17:13:40 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Sébastien Loriot 52ad8a136c remove any reference to lapack in the doc 2012-10-18 14:22:20 +00:00
Sébastien Loriot ba2b7aef65 remove any reference to taucs 2012-10-18 13:46:11 +00:00
Philipp Möller 24b7b586cc Remove the borks that were created by the script that introduced
anchors for top-level headings.
2012-10-05 13:07:09 +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 1121465b98 Fix problems pointed out in Marc's comments. 2012-09-27 12:00:31 +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 0aa7cd1c3b Global heading reduction. Rename some Parameter section to Template
Parameters. Fix dependencies.
2012-09-21 09:42:24 +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
Philipp Möller 864aebe2e5 Merge next.
This commit also updates the respective mock-headers when the
corresponding .tex documentation has changed. This has been the case for:

AABB_tree/doc_tex/AABB_tree_ref/AABBGeomTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABBTraits.tex
AABB_tree/doc_tex/AABB_tree_ref/AABB_traits.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_features.tex
Mesh_3/doc_tex/Mesh_3_ref/parameters_no_features.tex
Number_types/doc_tex/NumberTypeSupport_ref/Interval_nt.tex
Number_types/doc_tex/NumberTypeSupport_ref/Lazy_exact_nt.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_2.tex
Spatial_searching/doc_tex/Spatial_searching_ref/Search_traits_3.tex
Triangulation_2/doc_tex/Triangulation_2_ref/Constrained_Delaunay_triangulation_2.tex
2012-09-12 14:14:22 +00:00
Andreas Fabri 4404ae44fe fix the width 2012-09-04 10:27:28 +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
Philipp Möller e2616dafb1 Rebuild the how_to_cite structure 2012-08-28 17:33:45 +00:00
Philipp Möller 47fecbdd73 remove extra space in the package description 2012-08-28 08:07:34 +00:00
Andreas Fabri 7b9e531c65 fix linking in \hasModel by backquoting 2012-08-27 13:40:53 +00:00
Laurent Rineau 2db4effa7e CMake: Fix the handling of cmake_policy
That is a followup-to my commit last year:
  | ------------------------------------------------------------------------
  | r63198 | lrineau | 2011-04-28 19:45:22 +0200 (Thu, 28 Apr 2011) | 5 lines
  | 
  | Try to fix my last revision about cmake_policy, with CMake-2.6.x
  | 
  | CMake gives an error if one tries to use cmake_policy(VERSION x.y.z) if
  | x.y.z is greater than the current CMake version.
  | 
  | ------------------------------------------------------------------------

The following check:
  if("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}" VERSION_GREATER 2.6)
is useless just after a call to:
 cmake_minimum_required(VERSION 2.6.2)



The script used to fix that was:


#!/usr/bin/env perl

$replacement=<<'END';
if("${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}" VERSION_GREATER 2.8.3)
  cmake_policy(VERSION 2.8.4)
else()
  cmake_policy(VERSION 2.6)
endif()
END

while(<>) {
    if(/if\("\${CMAKE_MAJOR_VERSION}.\${CMAKE_MINOR_VERSION}" VERSION_GREATER 2.6\)/) {
        while(<>) {
            if(/^endif\(\)/) {
                print "$replacement";
                while(<>) {
                    print;
                }
                exit 0
            }
        }
    }
    print;
}
2012-08-22 12:35:03 +00:00
Andreas Fabri 29417ac142 workaround for mathmode in caption 2012-08-21 13:18:50 +00:00
Andreas Fabri af87732f6a Add \anchor of chapters 2012-08-21 10:18:58 +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 171c4bbd51 more packages 2012-08-16 17:15:27 +00:00
Eric Berberich 357d6258f5 cmake's link_libraries is deprecated
removed almost all occurenced (missing UseFiles). While
doing so, some CMakeLists.txt could also be simplified. In fact
many more CMakeLists.txt can be simplified, in one of two ways:
1) add external libs to CGAL_3RD_PARTY_LIBRARIES and
2) call cgal_create_single_source_program
2012-08-03 22:32:39 +00:00
Philipp Möller 495fac8ea1 Merge from next 2012-07-27 17:58:52 +00:00
Sébastien Loriot e702f20986 Eigen 3-1 is out.
Require Eigen 3.1.0 in CMake scripts.
2012-06-27 12:38:32 +00:00
Philipp Möller b529971917 Merge the changes to ccPrecond and ccPostcond that have been in
features/doxy-pmoeller and add changes for ccRequires on top of it.

ATTN: This changeset should be unmerged before the whole branch goes
      back into next.
2012-06-20 13:57:36 +00:00
Sébastien Loriot 7bb19c0e5e add third party link 2012-01-20 08:19:20 +00:00
Laurent Rineau 3239da640d merge changes from next; 2012-01-17 10:28:12 +00:00
Laurent Rineau a37c74d534 Add license files, per package 2012-01-16 15:54:22 +00:00
Sébastien Loriot cee248ca54 merge from next 2012-01-13 18:48:35 +00:00
Laurent Rineau 2af2160942 Turn \ccLicenseQPL into \ccLicenseGPL 2012-01-13 17:13:55 +00:00
Laurent Rineau 8f59fd9592 Turn QPL into LGPLv3+ 2012-01-13 16:33:35 +00:00
Andreas Fabri 055248b0e4 Remove unnecessary #includes 2012-01-12 16:08:02 +00:00
Sébastien Loriot 9b75cd5506 require Eigen 3.1 or greater 2011-12-22 16:06:37 +00:00
Sébastien Loriot bdcf26bb20 merge next 2011-12-01 09:19:02 +00:00
Laurent Rineau 93486787c3 The inside of ccPkgDescription must not contain black lines between macros
Otherwise that inserts a buggy "<p>" tag in the package overview where the
doctype does not allow it.
2011-11-15 19:16:23 +00:00
Sébastien Loriot 3a3417766a missing space
keep original format Solvers as ...
2011-11-07 10:18:55 +00:00
Andreas Fabri 2d57319daa Add static_cast to avoid warning 2011-10-20 11:16:20 +00:00
Marc Pouget 8083239fee Changed the title of the package according to the update of the APP deposit 2011-10-03 14:07:26 +00:00
Sébastien Loriot 554f62d411 remove executable property from copyright files 2011-10-03 08:18:16 +00:00
Andreas Fabri d10a333947 Add a file with the copyright holder(s) to the package_info 2011-09-29 20:45:16 +00:00
Laurent Rineau fdb7ea6c6b prepare ccPkgHowToCiteCgal for CGAL-3.10 (in 2012) 2011-09-28 16:15:05 +00:00
Sébastien Loriot 26e10e4722 merge from next 2011-09-23 11:52:20 +00:00
Sébastien Loriot 62ed832e2b *Add a model for SVDTraits using Eigen and use it by default. Update the doc.
*Add non-sparse matrix class (thus renamimg of the existing one)
*specialisation of the matrix class in Eigen_solver_traits according
 whether this is a symmetric or asymmetric matrix
*update use-files of lapack and Taucs to get definitions
2011-09-21 12:36:13 +00:00
Sébastien Loriot 0bc88e957a documentation bugfix (a function was used but not documented) 2011-09-21 07:56:29 +00:00
Laurent Rineau 369498d1e5 Cancel revision 64607. There had been a problem with the branch.
| ------------------------------------------------------------------------
  | r64607 | efif | 2011-07-05 17:27:04 +0200 (Tue, 05 Jul 2011) | 1 line
  | 
  | Merged feature-branch Aos_2-new_functors-tau into next
  | ------------------------------------------------------------------------
2011-07-06 11:11:58 +00:00