Browse Source

Platform: removed autolink-preventing % noise.

pull/77/head
Vladimír Vondruš 12 years ago
parent
commit
984b8003ea
  1. 4
      src/Magnum/Platform/AbstractXApplication.h
  2. 6
      src/Magnum/Platform/AndroidApplication.h
  3. 12
      src/Magnum/Platform/GlutApplication.h
  4. 4
      src/Magnum/Platform/GlxApplication.h
  5. 8
      src/Magnum/Platform/NaClApplication.h
  6. 2
      src/Magnum/Platform/Screen.h
  7. 2
      src/Magnum/Platform/ScreenedApplication.h
  8. 18
      src/Magnum/Platform/Sdl2Application.h
  9. 4
      src/Magnum/Platform/WindowlessCglApplication.h
  10. 4
      src/Magnum/Platform/WindowlessGlxApplication.h
  11. 4
      src/Magnum/Platform/WindowlessNaClApplication.h
  12. 4
      src/Magnum/Platform/WindowlessWglApplication.h
  13. 6
      src/Magnum/Platform/XEglApplication.h
  14. 2
      src/Magnum/Platform/magnum-info.cpp

4
src/Magnum/Platform/AbstractXApplication.h

@ -195,7 +195,7 @@ class AbstractXApplication {
CORRADE_ENUMSET_OPERATORS(AbstractXApplication::Flags)
/**
@brief %Configuration
@brief Configuration
Double-buffered OpenGL context.
@see @ref GlxApplication::GlxApplication(), @ref XEglApplication::XEglApplication(),
@ -255,7 +255,7 @@ class AbstractXApplication::Configuration {
class AbstractXApplication::InputEvent {
public:
/**
* @brief %Modifier
* @brief Modifier
*
* @see @ref Modifiers, @ref modifiers()
*/

6
src/Magnum/Platform/AndroidApplication.h

@ -110,9 +110,9 @@ can be then installed directly on the device or emulator using `adb install`.
## General usage
For CMake you need to copy `FindEGL.cmake` and `FindOpenGLES2.cmake` (or
`FindOpenGLES3.cmake`) from `modules/` directory in %Magnum source to `modules/`
`FindOpenGLES3.cmake`) from `modules/` directory in Magnum source to `modules/`
dir in your project (so it is able to find EGL and OpenGL ES libraries).
Request `%AndroidApplication` component, add
Request `AndroidApplication` component, add
`${MAGNUM_ANDROIDAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_ANDROIDAPPLICATION_LIBRARIES}`. If no other application is requested,
you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
@ -317,7 +317,7 @@ class AndroidApplication {
CORRADE_ENUMSET_OPERATORS(AndroidApplication::Flags)
/**
@brief %Configuration
@brief Configuration
Double-buffered RGBA canvas with depth and stencil buffers.
@see @ref AndroidApplication(), @ref createContext(), @ref tryCreateContext()

12
src/Magnum/Platform/GlutApplication.h

@ -74,7 +74,7 @@ See @ref cmake for more information.
## General usage
In CMake you need to request `%GlutApplication` component, add
In CMake you need to request `GlutApplication` component, add
`${MAGNUM_GLUTAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_GLUTAPPLICATION_LIBRARIES}`. If no other application is requested,
you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
@ -273,7 +273,7 @@ class GlutApplication {
};
/**
@brief %Configuration
@brief Configuration
Double-buffered RGBA window with depth and stencil buffers.
@see @ref GlutApplication(), @ref createContext(), @ref tryCreateContext()
@ -281,7 +281,7 @@ Double-buffered RGBA window with depth and stencil buffers.
class GlutApplication::Configuration {
public:
/**
* @brief %Context flag
* @brief Context flag
*
* @see @ref Flags, @ref setFlags()
*/
@ -290,7 +290,7 @@ class GlutApplication::Configuration {
};
/**
* @brief %Context flags
* @brief Context flags
*
* @see @ref setFlags()
*/
@ -331,7 +331,7 @@ class GlutApplication::Configuration {
return *this;
}
/** @brief %Context flags */
/** @brief Context flags */
Flags flags() const { return _flags; }
/**
@ -345,7 +345,7 @@ class GlutApplication::Configuration {
return *this;
}
/** @brief %Context version */
/** @brief Context version */
Version version() const { return _version; }
/**

4
src/Magnum/Platform/GlxApplication.h

@ -52,7 +52,7 @@ more information.
## General usage
In CMake you need to request `%GlxApplication` component, add
In CMake you need to request `GlxApplication` component, add
`${MAGNUM_GLXAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_GLXAPPLICATION_LIBRARIES}`. If no other application is requested, you
can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
@ -79,7 +79,7 @@ class GlxApplication: public AbstractXApplication {
/**
* @brief Default constructor
* @param arguments Application arguments
* @param configuration %Configuration
* @param configuration Configuration
*
* Creates application with default or user-specified configuration.
* See @ref AbstractXApplication::Configuration "Configuration" for

8
src/Magnum/Platform/NaClApplication.h

@ -117,8 +117,8 @@ You can then open `MyApplication` through your webserver in Chrome (e.g.
## General usage
For CMake you need to copy `FindOpenGLES2.cmake` from `modules/` directory in
%Magnum source to `modules/` dir in your project (so it is able to find OpenGL
ES). Request `%NaClApplication` component, add
Magnum source to `modules/` dir in your project (so it is able to find OpenGL
ES). Request `NaClApplication` component, add
`${MAGNUM_NACLAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_NACLAPPLICATION_LIBRARIES}`. If no other application is requested,
you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}` and
@ -395,7 +395,7 @@ class NaClApplication: public pp::Instance, public pp::Graphics3DClient, public
};
/**
@brief %Configuration
@brief Configuration
Double-buffered RGBA canvas with depth and stencil buffers.
@see @ref NaClApplication(), @ref createContext(), @ref tryCreateContext()
@ -469,7 +469,7 @@ propagated to the browser.
class NaClApplication::InputEvent {
public:
/**
* @brief %Modifier
* @brief Modifier
*
* @see @ref Modifiers, @ref modifiers()
* @todo AltGr + PP_INPUTEVENT_MODIFIER_ISKEYPAD, PP_INPUTEVENT_MODIFIER_ISAUTOREPEAT

2
src/Magnum/Platform/Screen.h

@ -134,7 +134,7 @@ template<class Application> class BasicScreen: private Containers::LinkedListIte
*/
void setPropagatedEvents(PropagatedEvents events) { _propagatedEvents = events; }
/** @brief %Application holding this screen */
/** @brief Application holding this screen */
template<class T = BasicScreenedApplication<Application>> T* application() {
return static_cast<T*>(Containers::LinkedListItem<BasicScreen<Application>, BasicScreenedApplication<Application>>::list());
}

2
src/Magnum/Platform/ScreenedApplication.h

@ -97,7 +97,7 @@ template<class Application> class BasicScreenedApplication: public Application,
/**
* @brief Default constructor
* @param arguments Application arguments
* @param configuration %Configuration
* @param configuration Configuration
*
* Creates application with default or user-specified configuration.
* See @ref Sdl2Application::Configuration "Configuration" for more

18
src/Magnum/Platform/Sdl2Application.h

@ -112,9 +112,9 @@ e.g. `http://localhost/emscripten/MyApplication.html`).
## General usage
For CMake you need to copy `FindSDL2.cmake` from `modules/` directory in
%Magnum source to `modules/` dir in your project (so it is able to find SDL2).
Magnum source to `modules/` dir in your project (so it is able to find SDL2).
In case of Emscripten you need also `FindOpenGLES2.cmake`. Request
`%Sdl2Application` component, add `${MAGNUM_SDL2APPLICATION_INCLUDE_DIRS}`
`Sdl2Application` component, add `${MAGNUM_SDL2APPLICATION_INCLUDE_DIRS}`
to include path and link to `${MAGNUM_SDL2APPLICATION_LIBRARIES}`. If no other
application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}`
and `${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. Again, see
@ -194,7 +194,7 @@ class Sdl2Application {
/**
* @brief Default constructor
* @param arguments Application arguments
* @param configuration %Configuration
* @param configuration Configuration
*
* Creates application with default or user-specified configuration.
* See @ref Configuration for more information. The program exits if
@ -416,7 +416,7 @@ class Sdl2Application {
CORRADE_ENUMSET_OPERATORS(Sdl2Application::Flags)
/**
@brief %Configuration
@brief Configuration
Centered non-resizable window with double-buffered OpenGL context and 24bit
depth buffer.
@ -426,7 +426,7 @@ class Sdl2Application::Configuration {
public:
#ifndef CORRADE_TARGET_EMSCRIPTEN
/**
* @brief %Context flag
* @brief Context flag
*
* @note Not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten".
* @see @ref Flags, @ref setFlags()
@ -443,7 +443,7 @@ class Sdl2Application::Configuration {
};
/**
* @brief %Context flags
* @brief Context flags
*
* @note Not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten".
* @see @ref setFlags()
@ -543,7 +543,7 @@ class Sdl2Application::Configuration {
#ifndef CORRADE_TARGET_EMSCRIPTEN
/**
* @brief %Context flags
* @brief Context flags
*
* @note Not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten".
*/
@ -562,7 +562,7 @@ class Sdl2Application::Configuration {
}
/**
* @brief %Context version
* @brief Context version
*
* @note Not available in @ref CORRADE_TARGET_EMSCRIPTEN "Emscripten".
*/
@ -631,7 +631,7 @@ CORRADE_ENUMSET_OPERATORS(Sdl2Application::Configuration::WindowFlags)
class Sdl2Application::InputEvent {
public:
/**
* @brief %Modifier
* @brief Modifier
*
* @see @ref Modifiers, @ref KeyEvent::modifiers(),
* @ref MouseEvent::modifiers(), @ref MouseMoveEvent::modifiers()

4
src/Magnum/Platform/WindowlessCglApplication.h

@ -67,7 +67,7 @@ See @ref cmake for more information.
## General usage
In CMake you need to request `%WindowlessCglApplication` component, add
In CMake you need to request `WindowlessCglApplication` component, add
`${MAGNUM_WINDOWLESSCGLAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_WINDOWLESSCGLAPPLICATION_LIBRARIES}`. If no other windowless
application is requested, you can also use generic
@ -157,7 +157,7 @@ class WindowlessCglApplication {
};
/**
@brief %Configuration
@brief Configuration
@see @ref WindowlessCglApplication(), @ref createContext(),
@ref tryCreateContext()

4
src/Magnum/Platform/WindowlessGlxApplication.h

@ -73,7 +73,7 @@ See @ref cmake for more information.
## General usage
In CMake you need to request `%WindowlessGlxApplication` component, add
In CMake you need to request `WindowlessGlxApplication` component, add
`${MAGNUM_WINDOWLESSGLXAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_WINDOWLESSGLXAPPLICATION_LIBRARIES}`. If no other windowless
application is requested, you can also use generic
@ -164,7 +164,7 @@ class WindowlessGlxApplication {
};
/**
@brief %Configuration
@brief Configuration
@see @ref WindowlessGlxApplication(), @ref createContext(),
@ref tryCreateContext()

4
src/Magnum/Platform/WindowlessNaClApplication.h

@ -69,7 +69,7 @@ more information.
## General Usage
In CMake you need to request `%WindowlessNaClApplication` component, add
In CMake you need to request `WindowlessNaClApplication` component, add
`${MAGNUM_WINDOWLESSNACLAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_WINDOWLESSNACLAPPLICATION_LIBRARIES}`. If no other windowless
application is requested, you can also use generic
@ -181,7 +181,7 @@ class WindowlessNaClApplication: public pp::Instance, public pp::Graphics3DClien
};
/**
@brief %Configuration
@brief Configuration
@see @ref WindowlessNaClApplication(), @ref createContext(),
@ref tryCreateContext()

4
src/Magnum/Platform/WindowlessWglApplication.h

@ -68,7 +68,7 @@ See @ref cmake for more information.
## General usage
In CMake you need to request `%WindowlessWglApplication` component, add
In CMake you need to request `WindowlessWglApplication` component, add
`${MAGNUM_WINDOWLESSWGLAPPLICATION_INCLUDE_DIRS}` to include path and link to
`${MAGNUM_WINDOWLESSWGLAPPLICATION_LIBRARIES}`. If no other windowless
application is requested, you can also use generic
@ -166,7 +166,7 @@ class WindowlessWglApplication {
};
/**
@brief %Configuration
@brief Configuration
@see @ref WindowlessWglApplication(), @ref createContext(),
@ref tryCreateContext()

6
src/Magnum/Platform/XEglApplication.h

@ -51,9 +51,9 @@ more information.
## General usage
For CMake you need to copy `FindEGL.cmake` from `modules/` directory in %Magnum
For CMake you need to copy `FindEGL.cmake` from `modules/` directory in Magnum
source to `modules/` dir in your project (so it is able to find EGL), request
`%XEglApplication` component, add `${MAGNUM_XEGLAPPLICATION_INCLUDE_DIRS}` to
`XEglApplication` component, add `${MAGNUM_XEGLAPPLICATION_INCLUDE_DIRS}` to
include path and link to `${MAGNUM_XEGLAPPLICATION_LIBRARIES}`. If no other
application is requested, you can also use generic `${MAGNUM_APPLICATION_INCLUDE_DIRS}`
and `${MAGNUM_APPLICATION_LIBRARIES}` aliases to simplify porting. See
@ -79,7 +79,7 @@ class XEglApplication: public AbstractXApplication {
/**
* @brief Default constructor
* @param arguments Application arguments
* @param configuration %Configuration
* @param configuration Configuration
*
* Creates application with default or user-specified configuration.
* See @ref AbstractXApplication::Configuration "Configuration" for

2
src/Magnum/Platform/magnum-info.cpp

@ -68,7 +68,7 @@
namespace Magnum {
/** @page magnum-info Magnum Info
@brief Displays information about %Magnum engine and OpenGL capabilities
@brief Displays information about Magnum engine and OpenGL capabilities
@section magnum-info-usage Usage

Loading…
Cancel
Save