Browse Source

Doc++

pull/289/head
Vladimír Vondruš 8 years ago
parent
commit
a1be168b7f
  1. 2
      doc/developers.dox
  2. 6
      doc/platforms-windows.dox
  3. 10
      doc/plugins.dox

2
doc/developers.dox

@ -96,6 +96,8 @@ required to follow them to the point.
- if the library is combined from an `OBJECT` library, add its name to
the above @cpp #ifdef @ce as well (and then explicitly add
@cmake target_compile_definitions(MagnumLibraryNameObjects PRIVATE "MagnumLibraryNameObjects_EXPORTS") @ce to `CMakeLists.txt` in case `BUILD_STATIC` is not set)
- the macro *does not* contain the full namespace path but rather mirrors
the library *file* name
9. Mention the directory and namespace in `doc/namespaces.dox`, basically
copy-pasting the following from existing documentation:
- directory-level doc block referencing the namespace

6
doc/platforms-windows.dox

@ -32,6 +32,12 @@ namespace Magnum {
@m_keyword{ANGLE OpenGL compatibility layer,,}
@m_footernavigation
@section platforms-windows-hidpi HiDPI support
Windows supports two approaches to advertising HiDPI support --- either via the
manifest file or through the [SetProcessDpiAwareness()](https://docs.microsoft.com/en-us/windows/desktop/api/shellscalingapi/nf-shellscalingapi-setprocessdpiawareness)
API. See the API documentation for more information.
@section platforms-windows-rt Windows RT
Windows RT is a restricted subset of Windows API, used for UWP / "Metro" /

10
doc/plugins.dox

@ -205,6 +205,16 @@ scene files:
@snippet plugins.cpp configuration
Besides affecting a single plugin instance, you can also change the
configuration globally via @ref Corrade::PluginManager::PluginMetadata::configuration() "PluginManager::PluginMetadata::configuration()".
That will affect all plugin instances created after. Resetting the global
configuration back to the initial state can be done by recreating the plugin
manager.
@section plugins-direct Direct usage of plugins
@todoc and also check that this is not already mentioned above
@section plugins-develop Developing your own plugins
See class documentation of particular plugin interfaces for more information

Loading…
Cancel
Save