Browse Source

Ability to link to extension functions in Doxygen documentation.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
df836f126d
  1. 1
      Doxyfile
  2. 24
      doc/coding-style.dox

1
Doxyfile

@ -201,6 +201,7 @@ ALIASES = \
"collisionoperator{2}=@relates \1\n@brief Collision of %\1 and %\2\n@see \2::operator%(const \1&) const" \ "collisionoperator{2}=@relates \1\n@brief Collision of %\1 and %\2\n@see \2::operator%(const \1&) const" \
"todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \ "todoc=@xrefitem todoc \"Documentation todo\" \"Documentation-related todo list\"" \
"fn_gl{1}=<a href=\"http://www.opengl.org/sdk/docs/man4/xhtml/gl\1.xml\">gl\1()</a>" \ "fn_gl{1}=<a href=\"http://www.opengl.org/sdk/docs/man4/xhtml/gl\1.xml\">gl\1()</a>" \
"fn_gl_extension{3}=<a href=\"http://www.opengl.org/registry/specs/\2/\3.txt\"><tt>gl\1<b></b>\2()</tt></a>" \
"def_gl{1}=`GL_\1`" \ "def_gl{1}=`GL_\1`" \
"requires_gl=@xrefitem requires-gl \"Requires desktop OpenGL\" \"Functionality requiring desktop OpenGL (not available on OpenGL ES)\" Not available on OpenGL ES." \ "requires_gl=@xrefitem requires-gl \"Requires desktop OpenGL\" \"Functionality requiring desktop OpenGL (not available on OpenGL ES)\" Not available on OpenGL ES." \
"requires_gl30=@xrefitem requires-gl30 \"Requires OpenGL 3.0\" \"Functionality requiring OpenGL 3.0\"" \ "requires_gl30=@xrefitem requires-gl30 \"Requires OpenGL 3.0\" \"Functionality requiring OpenGL 3.0\"" \

24
doc/coding-style.dox

@ -49,6 +49,16 @@ the operator is implemented (not of class in which the operator is
implemented), thus efficiently connecting the two classes together in the implemented), thus efficiently connecting the two classes together in the
documentation. documentation.
@subsubsection documentation-commands-extension Links to OpenGL extensions
If an OpenGL extension is referenced in the documentation, it should be done
with @c \@extension command:
@code
@extension{ARB,timer_query}
@endcode
It produces link to the specification of the extension in OpenGL registry,
e.g. @extension{ARB,timer_query}.
@subsubsection documentation-commands-ref_gl Links to related OpenGL functions and definitions @subsubsection documentation-commands-ref_gl Links to related OpenGL functions and definitions
If an function touches OpenGL, related OpenGL functions should be documented If an function touches OpenGL, related OpenGL functions should be documented
@ -64,15 +74,15 @@ inline static void setSeamless(bool enabled) {
It produces link to the online manual, in this case @fn_gl{Enable}/@fn_gl{Disable} It produces link to the online manual, in this case @fn_gl{Enable}/@fn_gl{Disable}
with @def_gl{TEXTURE_CUBE_MAP_SEAMLESS}. with @def_gl{TEXTURE_CUBE_MAP_SEAMLESS}.
@subsubsection documentation-commands-extension Links to OpenGL extensions For functions which are not part of OpenGL core specification, but only as
extensions, use @c \@fn_gl_extension command, e.g.
If an OpenGL extension is referenced in the documentation, it should be done
with @c \@extension command:
@code @code
@extension{ARB,timer_query} @fn_gl_extension{NamedCopyBufferSubData,EXT,direct_state_access}
@endcode @endcode
It produces link to the specification of the extension in OpenGL registry, First parameter is function name without the suffix, the second two parameters
e.g. @extension{ARB,timer_query}. are the same as in @c \@extension command. It produced link to extension
specification, with function name as link text, in this case
@fn_gl_extension{NamedCopyBufferSubData,EXT,direct_state_access}.
@subsubsection documentation-commands-requires Classes and functions requiring specific OpenGL version or extensions @subsubsection documentation-commands-requires Classes and functions requiring specific OpenGL version or extensions

Loading…
Cancel
Save