diff options
| author | Chad Versace <chad.versace@linux.intel.com> | 2012-05-17 10:40:24 -0700 |
|---|---|---|
| committer | Chad Versace <chad.versace@linux.intel.com> | 2012-05-17 11:41:10 -0700 |
| commit | de71c16e066d3b87d2a4e8cb5be07d43044aa4b6 (patch) | |
| tree | 5f5bb26892220edf4d4066dfb622c60228e8b2be /include | |
| parent | 777bc79d4642503e3413bb4cfcc267fee219123d (diff) | |
include: Remove refs to WAFFLE_OPENGL_API in waffle_init doxygen
The enum no longer exists.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/waffle/waffle_init.h | 30 |
1 files changed, 1 insertions, 29 deletions
diff --git a/include/waffle/waffle_init.h b/include/waffle/waffle_init.h index 8adfa75..3d2285f 100644 --- a/include/waffle/waffle_init.h +++ b/include/waffle/waffle_init.h @@ -48,11 +48,6 @@ extern "C" { /// attrib_list is null or empty, then all attributes assume their default /// values. /// -/// Some attribute combinations are inherently invalid due to platform or API -/// incompatibilities. For example, desktop OpenGL is not available on -/// Android. Providing such an attribute list produces the error -/// @c WAFFLE_INCOMPATIBLE_ATTRIBUTES. -/// /// |Name | Required | Type | Default | Choices | /// |:---------------------------------------|:--------:|-----:|--------:|:-----------------------------| /// | WAFFLE_PLATFORM | yes | enum | none | WAFFLE_PLATFORM_ANDROID | @@ -60,32 +55,13 @@ extern "C" { /// | . | . | . | . | WAFFLE_PLATFORM_GLX | /// | . | . | . | . | WAFFLE_PLATFORM_WAYLAND | /// | . | . | . | . | WAFFLE_PLATFORM_X11_EGL | -/// | . | . | . | . | . | -/// | WAFFLE_OPENGL_API | yes | enum | none | WAFFLE_OPENGL | -/// | . | . | . | . | WAFFLE_OPENGL_ES1 | -/// | . | . | . | . | WAFFLE_OPENGL_ES2 | /// /// /// ### Example Attribute Lists ### /// -/// Below is a valid attribute list for Android. -/// -/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.c} -/// const int32_t android_good[] = { -/// WAFFLE_PLATFORM, WAFFLE_PLATFORM_ANDROID, -/// WAFFLE_OPENGL_API, WAFFLE_OPENGL_ES2, -/// 0, -/// } -/// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -/// -/// Below is an invalid attribute list because desktop OpenGL is not availabe -/// on Android. Passing it to waffle_init() will produce the error -/// @c WAFFLE_INCOMPATIBLE_ATTRIBUTES. -/// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.c} -/// const int32_t android_bad[] = { +/// const int32_t attrib_list[] = { /// WAFFLE_PLATFORM, WAFFLE_PLATFORM_ANDROID, -/// WAFFLE_OPENGL_API, WAFFLE_OPENGL, /// 0, /// } /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -101,10 +77,6 @@ extern "C" { /// An item in @a attrib_list is unrecognized, missing, or has an /// invalid value. /// -/// - WAFFLE_INCOMPATIBLE_ATTRIBUTES @n -/// The attribute list contains attributes that conflict with each -/// other. -/// /// @see waffle_enum /// WAFFLE_API bool |