From 875e22e730d593d6c205ab77a132c0f0c8937351 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 2 Jan 2018 00:34:59 +0100 Subject: [PATCH] Updates for public docs. --- Doxyfile-mcss | 6 ++++-- Doxyfile-public | 16 +++++++++------- doc/mainpage.dox | 2 +- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/Doxyfile-mcss b/Doxyfile-mcss index be2f42148..45db80b57 100644 --- a/Doxyfile-mcss +++ b/Doxyfile-mcss @@ -76,6 +76,8 @@ 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_HEADER = "
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.

" +M_PAGE_FINE_PRINT = "

Magnum docs. Part of the Magnum project, copyright © Vladimír Vondruš and contributors, 2010–2018.
Generated by Doxygen {doxygen_version} and m.css. Contact the team via GitHub, Gitter, e-mail or Twitter.

" + +# kate: hl Doxyfile diff --git a/Doxyfile-public b/Doxyfile-public index 32aed85d7..d11719dc2 100644 --- a/Doxyfile-public +++ b/Doxyfile-public @@ -1,6 +1,7 @@ @INCLUDE = Doxyfile-mcss -## Patches for the m.css-generated docs. Just need to generate XML, that's it. +## Patches for the public docs. Hiding internal stuff, using a different +## stylesheet and relocating Corrade links to the public Corrade docs. OUTPUT_DIRECTORY = build/doc-public/ GENERATE_TAGFILE = build/doc-public/magnum.tag @@ -71,10 +72,11 @@ ALIASES = \ 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 +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.

" +M_PAGE_HEADER = "
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.
" + +# kate: hl Doxyfile diff --git a/doc/mainpage.dox b/doc/mainpage.dox index a87c8634f..b3481ce4e 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -24,7 +24,7 @@ */ namespace Magnum { -/** @mainpage +/** @mainpage Magnum Magnum is a 2D/3D graphics engine written in C++11/C++14 and modern OpenGL. Its goal is to simplify low-level graphics development and interaction with OpenGL