Browse Source

doc: scaffolding for the new tweakable literal support.

pull/297/head
Vladimír Vondruš 8 years ago
parent
commit
be58f21318
  1. 1
      Doxyfile
  2. 1
      Doxyfile-mcss
  3. 1
      Doxyfile-public
  4. 15
      doc/00-page-order.dox
  5. 5
      doc/coding-style.dox

1
Doxyfile

@ -242,6 +242,7 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1 @brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref Corrade::Utility::Debug and friends." \
"configurationvalueref{1}=@see @ref configurationvalues \"Corrade::Utility::ConfigurationValue<\1>\"" \
"configurationvalue{1}=@brief Configuration value parser and writer @xrefitem configurationvalues \"Configuration value parser and writer\" \"Configuration value parsers and writers for custom types\" Allows parsing and writing @ref \1 from and to @ref Corrade::Utility::Configuration and use it with @ref Corrade::Utility::Arguments." \
"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" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \

1
Doxyfile-mcss

@ -22,6 +22,7 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1 @brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref Corrade::Utility::Debug and friends." \
"configurationvalueref{1}=@see @ref configurationvalues \"Corrade::Utility::ConfigurationValue<\1>\"" \
"configurationvalue{1}=@brief Configuration value parser and writer @xrefitem configurationvalues \"Configuration value parser and writer\" \"Configuration value parsers and writers for custom types\" Allows parsing and writing @ref \1 from and to @ref Corrade::Utility::Configuration and use it with @ref Corrade::Utility::Arguments." \
"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" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \

1
Doxyfile-public

@ -18,6 +18,7 @@ ALIASES = \
"debugoperatorclassenum{2}=@relatesalso \1 @brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \2 with @ref Corrade::Utility::Debug and friends." \
"configurationvalueref{1}=@see @ref configurationvalues \"Corrade::Utility::ConfigurationValue<\1>\"" \
"configurationvalue{1}=@brief Configuration value parser and writer @xrefitem configurationvalues \"Configuration value parser and writer\" \"Configuration value parsers and writers for custom types\" Allows parsing and writing @ref \1 from and to @ref Corrade::Utility::Configuration and use it with @ref Corrade::Utility::Arguments." \
"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" \
"todoc=@todo" \

15
doc/00-page-order.dox

@ -44,15 +44,22 @@
@page coding-style Coding style
@page debugoperators Debug output operators for custom types
See also and @ref configurationvalues and a @m_class{m-dox-external}
[related section in Corrade](https://doc.magnum.graphics/corrade/corrade-configurationvalues.html).
See also and @ref configurationvalues, @ref tweakableliterals and a
@m_class{m-dox-external} [related section in Corrade](https://doc.magnum.graphics/corrade/corrade-debugoperators.html).
@todoc remove the above workaround once Doxygen is not totally fucked up and able to export xrefitems to tagfiles
@page configurationvalues Configuration value parsers and writers for custom types
See also @ref debugoperators and a @m_class{m-dox-external}
[related section in Corrade](https://doc.magnum.graphics/corrade/corrade-debugoperators.html).
See also @ref debugoperators, @ref tweakableliterals and a
@m_class{m-dox-external} [related section in Corrade](https://doc.magnum.graphics/corrade/corrade-configurationvalues.html).
@todoc remove the above workaround once Doxygen is not totally fucked up and able to export xrefitems to tagfiles
@page tweakableliterals Tweakable literal parsers
See also @ref debugoperators, @ref configurationvalues and a
@m_class{m-dox-external} [related section in Corrade](https://doc.magnum.graphics/corrade/corrade-tweakableliterals.html).
@todoc remove the above workaround once Doxygen is not totally fucked up and able to export xrefitems to tagfiles

5
doc/coding-style.dox

@ -91,8 +91,9 @@ appropriately mark the class/function
Additionally to @c \@todoc, @c \@debugoperator, @c \@debugoperatorenum,
@c \@debugoperatorclassenum, @c \@configurationvalue, @c \@configurationvalueref,
@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](http://mcss.mosra.cz/doxygen/#theme-specific-commands),
@c \@tweakableliteral, @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](http://mcss.mosra.cz/doxygen/#theme-specific-commands),
these are defined:
@subsubsection coding-style-documentation-commands-code Code

Loading…
Cancel
Save