From 302cf8ffe275df66fc615b694249a2f36c2605b2 Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Tue, 9 Jun 2015 11:40:07 +0200 Subject: [PATCH] Add missing documentation for TriangularViewImpl --- Eigen/src/SparseCore/SparseTriangularView.h | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Eigen/src/SparseCore/SparseTriangularView.h b/Eigen/src/SparseCore/SparseTriangularView.h index 7695f299e..0e6c01531 100644 --- a/Eigen/src/SparseCore/SparseTriangularView.h +++ b/Eigen/src/SparseCore/SparseTriangularView.h @@ -11,11 +11,17 @@ #ifndef EIGEN_SPARSE_TRIANGULARVIEW_H #define EIGEN_SPARSE_TRIANGULARVIEW_H -#ifndef EIGEN_PARSED_BY_DOXYGEN -// Doxygen gets confused with template specialization: -// https://bugzilla.gnome.org/show_bug.cgi?id=406027 namespace Eigen { +/** \ingroup SparseCore_Module + * + * \brief Base class for a triangular part in a \b sparse matrix + * + * This class is an abstract base class of class TriangularView, and objects of type TriangularViewImpl cannot be instantiated. + * It extends class TriangularView with additional methods which are available for sparse expressions only. + * + * \sa class TriangularView, SparseMatrixBase::triangularView() + */ template class TriangularViewImpl : public SparseMatrixBase > { @@ -278,6 +284,4 @@ SparseMatrixBase::triangularView() const } // end namespace Eigen -#endif // not EIGEN_PARSED_BY_DOXYGEN - #endif // EIGEN_SPARSE_TRIANGULARVIEW_H