diff options
Diffstat (limited to 'doc/Doxyfile.in')
| -rw-r--r-- | doc/Doxyfile.in | 25 |
1 files changed, 10 insertions, 15 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index da99d3592..64bb7bd01 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,11 +1,3 @@ -################################################################################ -## ## -## WARNING ## -## ## -## all modifications in this file must be reported in eigen2/Mainpage.dox ## -## ## -################################################################################ - # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # @@ -205,20 +197,22 @@ TAB_SIZE = 8 ALIASES = "only_for_vectors=This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column." \ "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \ - "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \ "cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode" \ - "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \ - "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \ - "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \ + "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \ "geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \ + "householder_module=This is defined in the %Householder module. \code #include <Eigen/Householder> \endcode" \ + "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \ "leastsquares_module=This is defined in the %LeastSquares module. \code #include <Eigen/LeastSquares> \endcode" \ - "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \ + "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \ + "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \ + "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \ "label=\bug" \ "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \ "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"" \ "note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \ "note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \ - "note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." + "note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \ + "note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. @@ -614,8 +608,9 @@ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = CMake* \ *.txt \ *.sh \ + *.orig \ *.diff \ - diff + diff \ *~ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |