From 8871334ed2ed8703ce15649618185209d8ae4daf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 20 May 2012 19:28:01 +0200 Subject: [PATCH] Updated Doxyfile for Doxygen 1.8.1. Doxygen produces some false-positive warnings for Matrix and Vector classes, but the generated documentation is fine. Worked around the warnings by using @copybrief and @copydetails instead of @copydoc. --- Doxyfile | 32 +++++++++++++------------------- src/Math/Matrix.h | 6 +++--- src/Math/Vector.h | 6 +++--- 3 files changed, 19 insertions(+), 25 deletions(-) diff --git a/Doxyfile b/Doxyfile index aead033d7..fb4f3f77b 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.0 +# Doxyfile 1.8.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -561,12 +561,6 @@ MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. @@ -958,12 +952,6 @@ HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports @@ -972,6 +960,17 @@ HTML_ALIGN_MEMBERS = YES HTML_DYNAMIC_SECTIONS = NO +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). @@ -1150,11 +1149,6 @@ GENERATE_TREEVIEW = NO ENUM_VALUES_PER_LINE = 4 -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. @@ -1722,7 +1716,7 @@ CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. diff --git a/src/Math/Matrix.h b/src/Math/Matrix.h index 29903db66..d9dabbd3f 100644 --- a/src/Math/Matrix.h +++ b/src/Math/Matrix.h @@ -61,7 +61,7 @@ template class Matrix { return *reinterpret_cast*>(data); } - /** @copydoc from(T*) */ + /** @copybrief from(T*) @copydetails from(T*) */ inline constexpr static const Matrix& from(const T* data) { return *reinterpret_cast*>(data); } @@ -128,14 +128,14 @@ template class Matrix { * order. */ inline T* data() { return _data; } - inline constexpr const T* data() const { return _data; } /**< @copydoc data() */ + inline constexpr const T* data() const { return _data; } /**< @copybrief data() @copydetails data() */ /** @brief %Matrix column */ inline Vector& operator[](size_t col) { return Vector::from(_data+col*size); } - /** @copydoc operator[]() */ + /** @copybrief operator[]() @copydetails operator[]() */ inline constexpr const Vector& operator[](size_t col) const { return Vector::from(_data+col*size); } diff --git a/src/Math/Vector.h b/src/Math/Vector.h index 9007ce6f4..56eb0c60b 100644 --- a/src/Math/Vector.h +++ b/src/Math/Vector.h @@ -48,7 +48,7 @@ template class Vector { return *reinterpret_cast*>(data); } - /** @copydoc from(T*) */ + /** @copybrief from(T*) @copydetails from(T*) */ inline constexpr static const Vector& from(const T* data) { return *reinterpret_cast*>(data); } @@ -118,11 +118,11 @@ template class Vector { * @return Array with the same size as the vector */ inline T* data() { return _data; } - inline constexpr const T* data() const { return _data; } /**< @copydoc data() */ + inline constexpr const T* data() const { return _data; } /**< @copybrief data() @copydetails data() */ /** @brief Value at given position */ inline T& operator[](size_t pos) { return _data[pos]; } - inline constexpr T operator[](size_t pos) const { return _data[pos]; } /**< @copydoc operator[]() */ + inline constexpr T operator[](size_t pos) const { return _data[pos]; } /**< @copybrief operator[]() @copydetails operator[]() */ /** @brief Equality operator */ inline bool operator==(const Vector& other) const {