diff options
| author | Chad Versace <chad.versace@linux.intel.com> | 2012-11-14 20:40:01 -0800 |
|---|---|---|
| committer | Chad Versace <chad.versace@linux.intel.com> | 2012-11-14 20:50:11 -0800 |
| commit | 95aa7bd644639568417b574505217b4f22ba4286 (patch) | |
| tree | d092c0dccd3fa40aba3104b88844dd3279ad40bc /man | |
| parent | 0ea26bd7735b3739b6543fb7e6cc66a261acc305 (diff) | |
man: Use citations for GLX and EGL functions
Change every reference to a GLx and ELG function into a <citerefentry>.
This ensures that links are created in the htmldocs.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/waffle_config.3.xml | 5 | ||||
| -rw-r--r-- | man/waffle_get_proc_address.3.xml | 6 | ||||
| -rw-r--r-- | man/waffle_make_current.3.xml | 4 |
3 files changed, 9 insertions, 6 deletions
diff --git a/man/waffle_config.3.xml b/man/waffle_config.3.xml index 9f196a6..8961b5e 100644 --- a/man/waffle_config.3.xml +++ b/man/waffle_config.3.xml @@ -144,8 +144,9 @@ struct waffle_config; <para> For example, one quirk that Waffle is able to accommodate is that some platforms require specification of context attributes at different times. GLX requires that the context attributes be specified at time of context creation - (<function>glXCreateContextAttribsARB</function>), but MacOS requires the attributes to be specified when choosing - a config (<function>CGLChoosePixelFormat</function>). Therefore, Waffle is constrained by MacOS to require the + [<citerefentry><refentrytitle>glXCreateContextAttribsARB</refentrytitle><manvolnum>3</manvolnum></citerefentry>] + but MacOS requires the attributes to be specified when choosing + a config [<function>CGLChoosePixelFormat</function>]. Therefore, Waffle is constrained by MacOS to require the attributes at time of <function>waffle_config_choose()</function>. </para> diff --git a/man/waffle_get_proc_address.3.xml b/man/waffle_get_proc_address.3.xml index a4d1832..a13f684 100644 --- a/man/waffle_get_proc_address.3.xml +++ b/man/waffle_get_proc_address.3.xml @@ -57,9 +57,11 @@ <term><function>waffle_get_proc_address()</function></term> <listitem> <para> - On GLX, this redirects to <function>glXGetProcAddress()</function>. + On GLX, this redirects to + <citerefentry><refentrytitle>glXGetProcAddress</refentrytitle><manvolnum>3</manvolnum></citerefentry>. - On EGL, this redirects to <function>eglGetProcAddress()</function>. + On EGL, this redirects to + <citerefentry><refentrytitle>eglGetProcAddress</refentrytitle><manvolnum>3</manvolnum></citerefentry>. On CGL, this function returns <constant>NULL</constant> diff --git a/man/waffle_make_current.3.xml b/man/waffle_make_current.3.xml index 0722c54..b16d166 100644 --- a/man/waffle_make_current.3.xml +++ b/man/waffle_make_current.3.xml @@ -75,8 +75,8 @@ <para> This function is analogous to - <function>glXMakeCurrent()</function>, - <function>eglMakeCurrent()</function>, and + <citerefentry><refentrytitle>glXMakeCurrent</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle><manvolnum>3</manvolnum></citerefentry>, and <function>[NSOpenGLContext makeCurrentContext]</function>. </para> </listitem> |