Browse Source

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.
pull/297/head
Vladimír Vondruš 8 years ago
parent
commit
89a1567d71
  1. 1
      Doxyfile
  2. 1
      Doxyfile-mcss
  3. 1
      Doxyfile-public
  4. 2
      doc/00-page-order.dox
  5. 4
      doc/coding-style.dox

1
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." \ "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" \ "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" \ "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\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \
"fn_gl{1}=<a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \ "fn_gl{1}=<a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \

1
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." \ "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" \ "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" \ "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\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \
"fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \ "fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \

1
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." \ "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" \ "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" \ "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\"" \ "thirdparty=@xrefitem credits-third-party \"Third-party components\" \"Third-party components\"" \
"todoc=@todo" \ "todoc=@todo" \
"fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \ "fn_gl{1}=@m_class{m-dox-external} <a href=\"https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/gl\1.xhtml\">gl\1()</a>" \

2
doc/00-page-order.dox

@ -36,6 +36,8 @@
@page vulkan Vulkan @page vulkan Vulkan
@page opengl OpenGL @page opengl OpenGL
@page openal OpenAL @page openal OpenAL
@page partialsupport List of partially supported features
@m_keyword{Partially supported features,,}
@page changelog Changelog @page changelog Changelog
@page changelog-old Archived changelogs @page changelog-old Archived changelogs

4
doc/coding-style.dox

@ -91,8 +91,8 @@ appropriately mark the class/function
Additionally to @c \@todoc, @c \@debugoperator, @c \@debugoperatorenum, Additionally to @c \@todoc, @c \@debugoperator, @c \@debugoperatorenum,
@c \@debugoperatorclassenum, @c \@configurationvalue, @c \@configurationvalueref, @c \@debugoperatorclassenum, @c \@configurationvalue, @c \@configurationvalueref,
@c \@tweakableliteral, @c \@thirdparty, @c \@cb, @c \@ce, @c \@cpp, @c \@cmake @c \@tweakableliteral, @c \@partialsupport, @c \@thirdparty, @c \@cb, @c \@ce,
defined @ref corrade-coding-style-documentation-commands "the same as in Corrade" @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), and all @c \@m_* commands from the [m.css theme](https://mcss.mosra.cz/doxygen/#theme-specific-commands),
these are defined: these are defined:

Loading…
Cancel
Save