diff --git a/doc/features.dox b/doc/features.dox index 2e0813e95..f06747f7c 100644 --- a/doc/features.dox +++ b/doc/features.dox @@ -26,6 +26,7 @@ namespace Magnum { /** @page features Feature overview @brief Fundamental principles and design goals +- @subpage platform -- @copybrief platform - @subpage types -- @copybrief types - @subpage matrix-vector -- @copybrief matrix-vector - @subpage transformations -- @copybrief transformations diff --git a/doc/namespaces.dox b/doc/namespaces.dox index e15b9876f..3fd741cb4 100644 --- a/doc/namespaces.dox +++ b/doc/namespaces.dox @@ -40,7 +40,8 @@ Contains classes for interacting with OpenGL. /** @namespace Magnum::Platform @brief Platform-specific application and context creation -Base classes for creating applications with various toolkits. +Base classes for creating applications with various toolkits. See @ref platform +for introduction. */ /** @dir Math diff --git a/doc/platform.dox b/doc/platform.dox new file mode 100644 index 000000000..15e664c7c --- /dev/null +++ b/doc/platform.dox @@ -0,0 +1,35 @@ +/* + This file is part of Magnum. + + Copyright © 2010, 2011, 2012, 2013 Vladimír Vondruš + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. +*/ + +namespace Magnum { +/** @page platform Platform support + +@brief Integration into windowing toolkits and creation of windowless contexts + +@tableofcontents + +@todoc write when the API is stabilized + +*/ +}