From 7f7728a592263affe77ccb1f1a450e1e566710dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Wed, 3 Apr 2019 17:02:59 +0200 Subject: [PATCH] doc: adapted to m.css changes. --- Doxyfile-mcss | 28 ++++++++++++++-------------- Doxyfile-public | 28 ++++++++++++++-------------- doc/00-page-order.dox | 6 +++--- 3 files changed, 31 insertions(+), 31 deletions(-) diff --git a/Doxyfile-mcss b/Doxyfile-mcss index 640599c65..13bab6627 100644 --- a/Doxyfile-mcss +++ b/Doxyfile-mcss @@ -14,7 +14,7 @@ TAGFILES = ../corrade/build/doc-mcss/corrade.tag=../../../../corra ../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. +## marked with m-doc-external CSS class to avoid ugly underline. ## Important: keep this in sync with Doxyfile and Doxyfile-public! ALIASES = \ @@ -27,11 +27,11 @@ ALIASES = \ "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()" \ - "fn_gl2{2}=@m_class{m-dox-external} gl\1()" \ - "fn_gl_extension{3}=@m_class{m-dox-external} gl\1\2()" \ + "fn_gl{1}=@m_class{m-doc-external} gl\1()" \ + "fn_gl2{2}=@m_class{m-doc-external} gl\1()" \ + "fn_gl_extension{3}=@m_class{m-doc-external} gl\1\2()" \ "def_gl{1}=`GL_\1`" \ - "def_gl_extension{3}=@m_class{m-dox-external} GL_\1_\2" \ + "def_gl_extension{3}=@m_class{m-doc-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\"" \ @@ -46,8 +46,8 @@ ALIASES = \ "requires_gl46=@xrefitem requires-gl46 \"Requires OpenGL 4.6\" \"Functionality requiring OpenGL 4.6\"" \ "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\"" \ - "gl_extension{2}=@m_class{m-dox-external} \1_\2" \ - "gl_extension2{3}=@m_class{m-dox-external} \1_\2" \ + "gl_extension{2}=@m_class{m-doc-external} \1_\2" \ + "gl_extension2{3}=@m_class{m-doc-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\"" \ @@ -56,19 +56,19 @@ ALIASES = \ "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_vk{1}=@m_class{m-dox-external} vk\1()" \ - "type_vk{1}=@m_class{m-dox-external} Vk\1" \ - "def_vk{2}=@m_class{m-dox-external} VK_\1" \ + "webgl_extension{2}=@m_class{m-doc-external} \1_\2" \ + "fn_vk{1}=@m_class{m-doc-external} vk\1()" \ + "type_vk{1}=@m_class{m-doc-external} Vk\1" \ + "def_vk{2}=@m_class{m-doc-external} VK_\1" \ "requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring specific Vulkan extension\"" \ - "vk_extension{2}=@m_class{m-dox-external} \1_\2" \ + "vk_extension{2}=@m_class{m-doc-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" \ + "al_extension{2}=@m_class{m-doc-external} AL_\1_\2" \ + "alc_extension{2}=@m_class{m-doc-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}" \ diff --git a/Doxyfile-public b/Doxyfile-public index 7342f5bcf..c4dc2a056 100644 --- a/Doxyfile-public +++ b/Doxyfile-public @@ -22,11 +22,11 @@ ALIASES = \ "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()" \ - "fn_gl2{2}=@m_class{m-dox-external} gl\1()" \ - "fn_gl_extension{3}=@m_class{m-dox-external} gl\1\2()" \ + "fn_gl{1}=@m_class{m-doc-external} gl\1()" \ + "fn_gl2{2}=@m_class{m-doc-external} gl\1()" \ + "fn_gl_extension{3}=@m_class{m-doc-external} gl\1\2()" \ "def_gl{1}=`GL_\1`" \ - "def_gl_extension{3}=@m_class{m-dox-external} GL_\1_\2" \ + "def_gl_extension{3}=@m_class{m-doc-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\"" \ @@ -41,8 +41,8 @@ ALIASES = \ "requires_gl46=@xrefitem requires-gl46 \"Requires OpenGL 4.6\" \"Functionality requiring OpenGL 4.6\"" \ "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\"" \ - "gl_extension{2}=@m_class{m-dox-external} \1_\2" \ - "gl_extension2{3}=@m_class{m-dox-external} \1_\2" \ + "gl_extension{2}=@m_class{m-doc-external} \1_\2" \ + "gl_extension2{3}=@m_class{m-doc-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\"" \ @@ -51,19 +51,19 @@ ALIASES = \ "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_vk{1}=@m_class{m-dox-external} vk\1()" \ - "type_vk{1}=@m_class{m-dox-external} Vk\1" \ - "def_vk{2}=@m_class{m-dox-external} VK_\1" \ + "webgl_extension{2}=@m_class{m-doc-external} \1_\2" \ + "fn_vk{1}=@m_class{m-doc-external} vk\1()" \ + "type_vk{1}=@m_class{m-doc-external} Vk\1" \ + "def_vk{2}=@m_class{m-doc-external} VK_\1" \ "requires_vk_extension=@xrefitem requires-vk-extension \"Requires Vulkan extension\" \"Functionality requiring specific Vulkan extension\"" \ - "vk_extension{2}=@m_class{m-dox-external} \1_\2" \ + "vk_extension{2}=@m_class{m-doc-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" \ + "al_extension{2}=@m_class{m-doc-external} AL_\1_\2" \ + "alc_extension{2}=@m_class{m-doc-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}" \ @@ -99,7 +99,7 @@ GENERATE_BUGLIST = NO 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 \ https://static.magnum.graphics/m-dark.compiled.css \ - https://static.magnum.graphics/m-dark.doxygen.compiled.css + https://static.magnum.graphics/m-dark.documentation.compiled.css ##! M_SEARCH_DOWNLOAD_BINARY = YES ##! M_SEARCH_BASE_URL = https://doc.magnum.graphics/magnum/ diff --git a/doc/00-page-order.dox b/doc/00-page-order.dox index 99f545338..aa72c83fa 100644 --- a/doc/00-page-order.dox +++ b/doc/00-page-order.dox @@ -49,21 +49,21 @@ @page debugoperators Debug output operators for custom types 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). +@m_class{m-doc-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, @ref tweakableliterals and a -@m_class{m-dox-external} [related section in Corrade](https://doc.magnum.graphics/corrade/corrade-configurationvalues.html). +@m_class{m-doc-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). +@m_class{m-doc-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