From 89a1567d71d4889c40d8b2a83b62cfb93a71007f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 19 Nov 2018 14:04:35 +0100 Subject: [PATCH] Add the \partialsupport Doxygen alias. Because I need to mark features that are supported only on some platforms and which are not tied to any GL version or anything. --- Doxyfile | 1 + Doxyfile-mcss | 1 + Doxyfile-public | 1 + doc/00-page-order.dox | 2 ++ doc/coding-style.dox | 4 ++-- 5 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Doxyfile b/Doxyfile index 44b23f093..bd431c23a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -245,6 +245,7 @@ ALIASES = \ "tweakableliteral{1}=@brief Tweakable literal parser @xrefitem tweakableliterals \"Tweakable literal parser\" \"Tweakable literal parsers\" Allows using @ref \1 with @ref Corrade::Utility::Tweakable." \ "collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \ "collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \ + "partialsupport=@xrefitem partialsupport \"Partially supported\" \"List of partially supported features\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "fn_gl{1}=gl\1()" \ diff --git a/Doxyfile-mcss b/Doxyfile-mcss index 9244b2a0a..91462a6e8 100644 --- a/Doxyfile-mcss +++ b/Doxyfile-mcss @@ -25,6 +25,7 @@ ALIASES = \ "tweakableliteral{1}=@brief Tweakable literal parser @xrefitem tweakableliterals \"Tweakable literal parser\" \"Tweakable literal parsers\" Allows using @ref \1 with @ref Corrade::Utility::Tweakable." \ "collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \ "collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \ + "partialsupport=@xrefitem partialsupport \"Partially supported\" \"List of partially supported features\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "fn_gl{1}=@m_class{m-dox-external} gl\1()" \ diff --git a/Doxyfile-public b/Doxyfile-public index 87b3a3cd5..f467873a8 100644 --- a/Doxyfile-public +++ b/Doxyfile-public @@ -21,6 +21,7 @@ ALIASES = \ "tweakableliteral{1}=@brief Tweakable literal parser @xrefitem tweakableliterals \"Tweakable literal parser\" \"Tweakable literal parsers\" Allows using @ref \1 with @ref Corrade::Utility::Tweakable." \ "collisionoccurenceoperator{2}=@relatesalso \1 @brief Collision occurence of @ref \1 and @ref \2 @see @ref \2::operator%(const \1&) const" \ "collisionoperator{2}=@relatesalso \1 @brief Collision of @ref \1 and @ref \2 @see @ref \2::operator/(const \1&) const" \ + "partialsupport=@xrefitem partialsupport \"Partially supported\" \"List of partially supported features\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \ "todoc=@todo" \ "fn_gl{1}=@m_class{m-dox-external} gl\1()" \ diff --git a/doc/00-page-order.dox b/doc/00-page-order.dox index 14e38bd4c..297ffe3fb 100644 --- a/doc/00-page-order.dox +++ b/doc/00-page-order.dox @@ -36,6 +36,8 @@ @page vulkan Vulkan @page opengl OpenGL @page openal OpenAL +@page partialsupport List of partially supported features +@m_keyword{Partially supported features,,} @page changelog Changelog @page changelog-old Archived changelogs diff --git a/doc/coding-style.dox b/doc/coding-style.dox index a4071ae1a..e8dca9061 100644 --- a/doc/coding-style.dox +++ b/doc/coding-style.dox @@ -91,8 +91,8 @@ appropriately mark the class/function Additionally to @c \@todoc, @c \@debugoperator, @c \@debugoperatorenum, @c \@debugoperatorclassenum, @c \@configurationvalue, @c \@configurationvalueref, -@c \@tweakableliteral, @c \@thirdparty, @c \@cb, @c \@ce, @c \@cpp, @c \@cmake -defined @ref corrade-coding-style-documentation-commands "the same as in Corrade" +@c \@tweakableliteral, @c \@partialsupport, @c \@thirdparty, @c \@cb, @c \@ce, +@c \@cpp, @c \@cmake defined @ref corrade-coding-style-documentation-commands "the same as in Corrade" and all @c \@m_* commands from the [m.css theme](https://mcss.mosra.cz/doxygen/#theme-specific-commands), these are defined: