diff --git a/Doxyfile b/Doxyfile index d203e3854..36e01d7a1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -234,6 +234,8 @@ TAB_SIZE = 8 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. +## Important: keep this in sync with Doxyfile-mcss and Doxyfile-public! + ALIASES = \ "debugoperator{1}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ "debugoperatorenum{1}=\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ @@ -278,7 +280,18 @@ ALIASES = \ "requires_al_extension=@xrefitem requires-al-extension \"Requires OpenAL extension\" \"Functionality requiring specific OpenAL extension\"" \ "al_extension{2}=AL_\1_\2" \ "alc_extension{2}=ALC_\1_\2" \ - "experimental=@attention This functionality is still experimental and may change in the future without keeping full backwards compatibility." + "experimental=@attention This functionality is still experimental and may change in the future without keeping full backwards compatibility." \ + "cb{1}=" \ + "cpp=" \ + "glsl=" \ + "cmake=" \ + "ce=" \ + "m_div{1}=" \ + "m_enddiv=" \ + "m_span{1}=" \ + "m_endspan=" \ + "m_class{1}=" \ + "m_footernavigation=" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" diff --git a/Doxyfile-mcss b/Doxyfile-mcss new file mode 100644 index 000000000..3ccb00acd --- /dev/null +++ b/Doxyfile-mcss @@ -0,0 +1,81 @@ +@INCLUDE = Doxyfile + +## Patches for the m.css-generated docs. Just need to generate XML, that's it. + +OUTPUT_DIRECTORY = build/doc-mcss/ +PROJECT_BRIEF = docs +GENERATE_HTML = NO +GENERATE_XML = YES +XML_PROGRAMLISTING = NO +GENERATE_TAGFILE = build/doc-mcss/magnum.tag +TAGFILES = ../corrade/build/doc-mcss/corrade.tag=../../../../corrade/build/doc-mcss/html \ + ../corrade/doc/stl.tag=http://en.cppreference.com/w/ + +## Added m.css-specific @m_* commands and all the GL/AL/extension links are +## marked with m-dox-external CSS class to avoid ugly underline. +## Important: keep this in sync with Doxyfile and Doxyfile-public! + +ALIASES = \ + "debugoperator{1}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ + "debugoperatorenum{1}=\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ + "debugoperatorclassenum{2}=@relatesalso \1\n@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." \ + "collisionoccurenceoperator{2}=@relatesalso \1\n@brief Collision occurence of \1 and \2\n@see \2::operator%(const \1&) const" \ + "collisionoperator{2}=@relatesalso \1\n@brief Collision of \1 and \2\n@see \2::operator/(const \1&) const" \ + "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ + "fn_gl{1}=@m_class{m-dox-external} gl\1()" \ + "fn_gl2{2}=@m_class{m-dox-external} gl\1()" \ + "fn_gl_extension{3}=@m_class{m-dox-external} gl\1\2()" \ + "def_gl{1}=`GL_\1`" \ + "def_gl_extension{3}=@m_class{m-dox-external} GL_\1_\2" \ + "deprecated_gl=@xrefitem opengl-deprecated \"Deprecated OpenGL API\" \"Deprecated OpenGL API list\"" \ + "requires_gl30=@xrefitem requires-gl30 \"Requires OpenGL 3.0\" \"Functionality requiring OpenGL 3.0\"" \ + "requires_gl31=@xrefitem requires-gl31 \"Requires OpenGL 3.1\" \"Functionality requiring OpenGL 3.1\"" \ + "requires_gl32=@xrefitem requires-gl32 \"Requires OpenGL 3.2\" \"Functionality requiring OpenGL 3.2\"" \ + "requires_gl33=@xrefitem requires-gl33 \"Requires OpenGL 3.3\" \"Functionality requiring OpenGL 3.3\"" \ + "requires_gl40=@xrefitem requires-gl40 \"Requires OpenGL 4.0\" \"Functionality requiring OpenGL 4.0\"" \ + "requires_gl41=@xrefitem requires-gl41 \"Requires OpenGL 4.1\" \"Functionality requiring OpenGL 4.1\"" \ + "requires_gl42=@xrefitem requires-gl42 \"Requires OpenGL 4.2\" \"Functionality requiring OpenGL 4.2\"" \ + "requires_gl43=@xrefitem requires-gl43 \"Requires OpenGL 4.3\" \"Functionality requiring OpenGL 4.3\"" \ + "requires_gl44=@xrefitem requires-gl44 \"Requires OpenGL 4.4\" \"Functionality requiring OpenGL 4.4\"" \ + "requires_gl45=@xrefitem requires-gl45 \"Requires OpenGL 4.5\" \"Functionality requiring OpenGL 4.5\"" \ + "requires_extension=@xrefitem requires-extension \"Requires OpenGL extension\" \"Functionality requiring specific OpenGL extension\"" \ + "requires_gl=@xrefitem requires-gl \"Requires desktop OpenGL\" \"Functionality requiring desktop OpenGL\"" \ + "extension{2}=@m_class{m-dox-external} \1_\2" \ + "extension2{3}=@m_class{m-dox-external} \1_\2" \ + "requires_gles20=@xrefitem requires-gles20 \"Requires OpenGL ES 2.0 / WebGL 1.0\" \"Functionality requiring OpenGL ES 2.0 or WebGL 1.0\"" \ + "requires_gles30=@xrefitem requires-gles30 \"Requires OpenGL ES 3.0\" \"Functionality requiring OpenGL ES 3.0\"" \ + "requires_gles31=@xrefitem requires-gles31 \"Requires OpenGL ES 3.1\" \"Functionality requiring OpenGL ES 3.1\"" \ + "requires_es_extension=@xrefitem requires-es-extension \"Requires OpenGL ES extension\" \"Functionality requiring specific OpenGL ES extension\"" \ + "requires_gles=@xrefitem requires-gles \"Requires OpenGL ES or desktop OpenGL\" \"Functionality requiring OpenGL ES or desktop OpenGL\"" \ + "requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ + "requires_webgl_extension=@xrefitem requires-webgl-extension \"Requires WebGL extension\" \"Functionality requiring specific WebGL extension\"" \ + "webgl_extension{2}=@m_class{m-dox-external} \1_\2" \ + "fn_al{1}=`al\1()`" \ + "fn_alc{1}=`alc\1()`" \ + "def_al{1}=`AL_\1`" \ + "def_alc{1}=`ALC_\1`" \ + "requires_al_extension=@xrefitem requires-al-extension \"Requires OpenAL extension\" \"Functionality requiring specific OpenAL extension\"" \ + "al_extension{2}=@m_class{m-dox-external} AL_\1_\2" \ + "alc_extension{2}=@m_class{m-dox-external} ALC_\1_\2" \ + "experimental=@attention This functionality is still experimental and may change in the future without keeping full backwards compatibility." \ + "cb{1}=@code{\1}" \ + "cpp=@code{.cpp}" \ + "glsl=@code{.glsl}" \ + "cmake=@code{.cmake}" \ + "ce=@endcode" \ + "m_div{1}=@xmlonly@endxmlonly" \ + "m_enddiv=@xmlonly@endxmlonly" \ + "m_span{1}=@xmlonly@endxmlonly" \ + "m_endspan=@xmlonly@endxmlonly" \ + "m_class{1}=@xmlonly@endxmlonly" \ + "m_footernavigation=@xmlonly@endxmlonly" + +HTML_EXTRA_STYLESHEET = \ + https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \ + ../css/m-dark+doxygen.compiled.css + +M_PAGE_HEADER = "

No need to panic

This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the archived version of this documentation page.

" + +M_PAGE_FINE_PRINT = "

Magnum docs. Part of the Magnum project, copyright © Vladimír Vondruš 2010–2017. Generated by Doxygen {doxygen_version} and m.css. Contact the author via e-mail, Jabber, Twitter or smoke signals.

" diff --git a/Doxyfile-public b/Doxyfile-public new file mode 100644 index 000000000..32aed85d7 --- /dev/null +++ b/Doxyfile-public @@ -0,0 +1,80 @@ +@INCLUDE = Doxyfile-mcss + +## Patches for the m.css-generated docs. Just need to generate XML, that's it. + +OUTPUT_DIRECTORY = build/doc-public/ +GENERATE_TAGFILE = build/doc-public/magnum.tag +TAGFILES = ../corrade/build/doc-public/corrade.tag=http://doc.magnum.graphics/corrade-ng/ \ + ../corrade/doc/stl.tag=http://en.cppreference.com/w/ + +## No need to expose TODO list or bug list in public docs. Aliases copied from +## Doxyfile-mcss, with @todoc changed to be just an alias to @todo so it also +## gets removed. Keep it in sync, please. + +ALIASES = \ + "debugoperator{1}=@relatesalso \1\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ + "debugoperatorenum{1}=\n@brief Debug output operator @xrefitem debugoperators \"Debug output operator\" \"Debug output operators for custom types\" Allows printing @ref \1 with @ref Corrade::Utility::Debug and friends." \ + "debugoperatorclassenum{2}=@relatesalso \1\n@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." \ + "collisionoccurenceoperator{2}=@relatesalso \1\n@brief Collision occurence of \1 and \2\n@see \2::operator%(const \1&) const" \ + "collisionoperator{2}=@relatesalso \1\n@brief Collision of \1 and \2\n@see \2::operator/(const \1&) const" \ + "todoc=@todo" \ + "fn_gl{1}=@m_class{m-dox-external} gl\1()" \ + "fn_gl2{2}=@m_class{m-dox-external} gl\1()" \ + "fn_gl_extension{3}=@m_class{m-dox-external} gl\1\2()" \ + "def_gl{1}=`GL_\1`" \ + "def_gl_extension{3}=@m_class{m-dox-external} GL_\1_\2" \ + "deprecated_gl=@xrefitem opengl-deprecated \"Deprecated OpenGL API\" \"Deprecated OpenGL API list\"" \ + "requires_gl30=@xrefitem requires-gl30 \"Requires OpenGL 3.0\" \"Functionality requiring OpenGL 3.0\"" \ + "requires_gl31=@xrefitem requires-gl31 \"Requires OpenGL 3.1\" \"Functionality requiring OpenGL 3.1\"" \ + "requires_gl32=@xrefitem requires-gl32 \"Requires OpenGL 3.2\" \"Functionality requiring OpenGL 3.2\"" \ + "requires_gl33=@xrefitem requires-gl33 \"Requires OpenGL 3.3\" \"Functionality requiring OpenGL 3.3\"" \ + "requires_gl40=@xrefitem requires-gl40 \"Requires OpenGL 4.0\" \"Functionality requiring OpenGL 4.0\"" \ + "requires_gl41=@xrefitem requires-gl41 \"Requires OpenGL 4.1\" \"Functionality requiring OpenGL 4.1\"" \ + "requires_gl42=@xrefitem requires-gl42 \"Requires OpenGL 4.2\" \"Functionality requiring OpenGL 4.2\"" \ + "requires_gl43=@xrefitem requires-gl43 \"Requires OpenGL 4.3\" \"Functionality requiring OpenGL 4.3\"" \ + "requires_gl44=@xrefitem requires-gl44 \"Requires OpenGL 4.4\" \"Functionality requiring OpenGL 4.4\"" \ + "requires_gl45=@xrefitem requires-gl45 \"Requires OpenGL 4.5\" \"Functionality requiring OpenGL 4.5\"" \ + "requires_extension=@xrefitem requires-extension \"Requires OpenGL extension\" \"Functionality requiring specific OpenGL extension\"" \ + "requires_gl=@xrefitem requires-gl \"Requires desktop OpenGL\" \"Functionality requiring desktop OpenGL\"" \ + "extension{2}=@m_class{m-dox-external} \1_\2" \ + "extension2{3}=@m_class{m-dox-external} \1_\2" \ + "requires_gles20=@xrefitem requires-gles20 \"Requires OpenGL ES 2.0 / WebGL 1.0\" \"Functionality requiring OpenGL ES 2.0 or WebGL 1.0\"" \ + "requires_gles30=@xrefitem requires-gles30 \"Requires OpenGL ES 3.0\" \"Functionality requiring OpenGL ES 3.0\"" \ + "requires_gles31=@xrefitem requires-gles31 \"Requires OpenGL ES 3.1\" \"Functionality requiring OpenGL ES 3.1\"" \ + "requires_es_extension=@xrefitem requires-es-extension \"Requires OpenGL ES extension\" \"Functionality requiring specific OpenGL ES extension\"" \ + "requires_gles=@xrefitem requires-gles \"Requires OpenGL ES or desktop OpenGL\" \"Functionality requiring OpenGL ES or desktop OpenGL\"" \ + "requires_webgl20=@xrefitem requires-webgl20 \"Requires WebGL 2.0\" \"Functionality requiring WebGL 2.0\"" \ + "requires_webgl_extension=@xrefitem requires-webgl-extension \"Requires WebGL extension\" \"Functionality requiring specific WebGL extension\"" \ + "webgl_extension{2}=@m_class{m-dox-external} \1_\2" \ + "fn_al{1}=`al\1()`" \ + "fn_alc{1}=`alc\1()`" \ + "def_al{1}=`AL_\1`" \ + "def_alc{1}=`ALC_\1`" \ + "requires_al_extension=@xrefitem requires-al-extension \"Requires OpenAL extension\" \"Functionality requiring specific OpenAL extension\"" \ + "al_extension{2}=@m_class{m-dox-external} AL_\1_\2" \ + "alc_extension{2}=@m_class{m-dox-external} ALC_\1_\2" \ + "experimental=@attention This functionality is still experimental and may change in the future without keeping full backwards compatibility." \ + "cb{1}=@code{\1}" \ + "cpp=@code{.cpp}" \ + "glsl=@code{.glsl}" \ + "cmake=@code{.cmake}" \ + "ce=@endcode" \ + "m_div{1}=@xmlonly@endxmlonly" \ + "m_enddiv=@xmlonly@endxmlonly" \ + "m_span{1}=@xmlonly@endxmlonly" \ + "m_endspan=@xmlonly@endxmlonly" \ + "m_class{1}=@xmlonly@endxmlonly" \ + "m_footernavigation=@xmlonly@endxmlonly" + +GENERATE_TODOLIST = NO +GENERATE_BUGLIST = NO + +# todo: re-enable when the site css is updated +#HTML_EXTRA_STYLESHEET = \ +# https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600&subset=latin-ext \ +# http://static.magnum.graphics/m-dark.compiled.css \ +# http://static.magnum.graphics/m-dark.doxygen.compiled.css + +M_PAGE_HEADER = "

No need to panic

This is a snapshot of a work-in-progress documentation theme. If you feel lost, miss something, or want to see the original Doxygen docs instead, head over to the archived version of this documentation page.

"