From 976f15ebca3f486902c3da4c98b8f92c3c4ed7a4 Mon Sep 17 00:00:00 2001 From: Guilhem Saurel Date: Tue, 16 Dec 2025 19:54:18 +0000 Subject: [PATCH] fix doc generation with doxygen 1.14 & 1.15 libeigen/eigen!2095 Closes #2976 --- Eigen/src/Core/ArithmeticSequence.h | 2 +- doc/Doxyfile.in | 2 +- doc/QuickReference.dox | 1 - doc/TutorialSlicingIndexing.dox | 3 +-- doc/UnalignedArrayAssert.dox | 2 +- 5 files changed, 4 insertions(+), 6 deletions(-) diff --git a/Eigen/src/Core/ArithmeticSequence.h b/Eigen/src/Core/ArithmeticSequence.h index ae6373dda..41617713f 100644 --- a/Eigen/src/Core/ArithmeticSequence.h +++ b/Eigen/src/Core/ArithmeticSequence.h @@ -182,7 +182,7 @@ namespace placeholders { * \returns a symbolic ArithmeticSequence representing the last \a size elements with increment \a incr. * * It is a shortcut for: \code seqN(last-(size-fix<1>)*incr, size, incr) \endcode - * + * \anchor Eigen_placeholders_lastN * \sa lastN(SizeType), seqN(FirstType,SizeType), seq(FirstType,LastType,IncrType) */ template auto lastN(SizeType size, IncrType incr) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 25a7e2e9a..445fc0a6f 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -32,7 +32,7 @@ ALIASES = "only_for_vectors=This is only for vectors (either row- "cpp14=[c++14]" \ "cpp17=[c++17]" \ "newin{1}=New in %Eigen \1." \ - eigenAutoToc= \ + "eigenAutoToc=" \ eigenManualPage=\defgroup EXTENSION_MAPPING = .h=C++ \ no_extension=C++ diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 1fb000fdc..4aece902c 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -551,7 +551,6 @@ Read-write access to sub-vectors: Default versions Optimized versions when the size \n is known at compile time - \code vec1.head(n)\endcode\code vec1.head()\endcodethe first \c n coeffs \code vec1.tail(n)\endcode\code vec1.tail()\endcodethe last \c n coeffs diff --git a/doc/TutorialSlicingIndexing.dox b/doc/TutorialSlicingIndexing.dox index 6ebaa2d6d..a1b00dfc4 100644 --- a/doc/TutorialSlicingIndexing.dox +++ b/doc/TutorialSlicingIndexing.dox @@ -114,8 +114,7 @@ Here are some examples for a 2D array/matrix \c A and a 1D array/vector \c v. As seen in the last example, referencing the last n elements (or rows/columns) is a bit cumbersome to write. This becomes even more tricky and error prone with a non-default increment. -Here comes \link Eigen::placeholders::lastN(SizeType) Eigen::placeholders::lastN(size) \endlink, and -\link Eigen::placeholders::lastN(SizeType,IncrType) Eigen::placeholders::lastN(size,incr) \endlink: +Here comes \ref Eigen_placeholders_lastN : diff --git a/doc/UnalignedArrayAssert.dox b/doc/UnalignedArrayAssert.dox index ca674a267..0ed6f8835 100644 --- a/doc/UnalignedArrayAssert.dox +++ b/doc/UnalignedArrayAssert.dox @@ -7,7 +7,7 @@ Hello! You are seeing this webpage because your program terminated on an asserti my_program: path/to/eigen/Eigen/src/Core/DenseStorage.h:44: Eigen::internal::matrix_array::internal::matrix_array() [with T = double, int Size = 2, int MatrixOptions = 2, bool Align = true]: -Assertion `(reinterpret_cast(array) & (sizemask)) == 0 && "this assertion +Assertion (reinterpret_cast(array) & (sizemask)) == 0 && "this assertion is explained here: http://eigen.tuxfamily.org/dox-devel/group__TopicUnalignedArrayAssert.html **** READ THIS WEB PAGE !!! ****"' failed.