mesa: update/fix doxygen comments

This commit is contained in:
Vinson Lee
2009-03-17 09:34:30 -06:00
committed by Brian Paul
parent c1f8de9954
commit 1eee1bac1f
12 changed files with 16 additions and 17 deletions

View File

@@ -23,7 +23,7 @@
*/ */
/** /**
* \file glapi_getproc. * \file glapi_getproc.c
* *
* Code for implementing glXGetProcAddress(), etc. * Code for implementing glXGetProcAddress(), etc.
* This was originally in glapi.c but refactored out. * This was originally in glapi.c but refactored out.

View File

@@ -179,7 +179,7 @@ GLfloat _mesa_ubyte_to_float_color_tab[256];
/** /**
* Swap buffers notification callback. * Swap buffers notification callback.
* *
* \param gc GL context. * \param ctx GL context.
* *
* Called by window system just before swapping buffers. * Called by window system just before swapping buffers.
* We have to finish any pending rendering. * We have to finish any pending rendering.
@@ -923,7 +923,7 @@ _mesa_initialize_context(GLcontext *ctx,
* \param share_list another context to share display lists with or NULL * \param share_list another context to share display lists with or NULL
* \param driverFunctions points to the dd_function_table into which the * \param driverFunctions points to the dd_function_table into which the
* driver has plugged in all its special functions. * driver has plugged in all its special functions.
* \param driverCtx points to the device driver's private context state * \param driverContext points to the device driver's private context state
* *
* \return pointer to a new __GLcontextRec or NULL if error. * \return pointer to a new __GLcontextRec or NULL if error.
*/ */

View File

@@ -707,7 +707,7 @@ unpack_image(GLuint dimensions, GLsizei width, GLsizei height, GLsizei depth,
/** /**
* Allocate space for a display list instruction. * Allocate space for a display list instruction.
* \param opcode the instruction opcode (OPCODE_* value) * \param opcode the instruction opcode (OPCODE_* value)
* \param size instruction size in bytes, not counting opcode. * \param bytes instruction size in bytes, not counting opcode.
* \return pointer to the usable data area (not including the internal * \return pointer to the usable data area (not including the internal
* opcode). * opcode).
*/ */

View File

@@ -24,7 +24,7 @@
/** /**
* \file exemem.c * \file execmem.c
* Functions for allocating executable memory. * Functions for allocating executable memory.
* *
* \author Keith Whitwell * \author Keith Whitwell

View File

@@ -197,8 +197,8 @@ _mesa_SelectBuffer( GLsizei size, GLuint *buffer )
/** /**
* Write a value of a record into the selection buffer. * Write a value of a record into the selection buffer.
* *
* \param CTX GL context. * \param ctx GL context.
* \param V value. * \param value value.
* *
* Verifies there is free space in the buffer to write the value and * Verifies there is free space in the buffer to write the value and
* increments the pointer. * increments the pointer.

View File

@@ -1011,7 +1011,7 @@ _mesa_warning( GLcontext *ctx, const char *fmtString, ... )
* Prints the message to stderr via fprintf(). * Prints the message to stderr via fprintf().
* *
* \param ctx GL context. * \param ctx GL context.
* \param s problem description string. * \param fmtString problem description string.
*/ */
void void
_mesa_problem( const GLcontext *ctx, const char *fmtString, ... ) _mesa_problem( const GLcontext *ctx, const char *fmtString, ... )

View File

@@ -1186,7 +1186,7 @@ make_1d_stack_mipmap(GLenum datatype, GLuint comps, GLint border,
/** /**
* \bugs * \bug
* There is quite a bit of refactoring that could be done with this function * There is quite a bit of refactoring that could be done with this function
* and \c make_2d_mipmap. * and \c make_2d_mipmap.
*/ */

View File

@@ -278,7 +278,7 @@ delete_renderbuffer_cb(GLuint id, void *data, void *userData)
* Deallocate a shared state object and all children structures. * Deallocate a shared state object and all children structures.
* *
* \param ctx GL context. * \param ctx GL context.
* \param ss shared state pointer. * \param shared shared state pointer.
* *
* Frees the display lists, the texture objects (calling the driver texture * Frees the display lists, the texture objects (calling the driver texture
* deletion callback to free its private data) and the vertex programs, as well * deletion callback to free its private data) and the vertex programs, as well

View File

@@ -712,7 +712,7 @@ _mesa_new_texture_image( GLcontext *ctx )
* Free texture image data. * Free texture image data.
* This function is a fallback called via ctx->Driver.FreeTexImageData(). * This function is a fallback called via ctx->Driver.FreeTexImageData().
* *
* \param teximage texture image. * \param texImage texture image.
* *
* Free the texture image data if it's not marked as client data. * Free the texture image data if it's not marked as client data.
*/ */
@@ -734,7 +734,7 @@ _mesa_free_texture_image_data(GLcontext *ctx,
/** /**
* Free texture image. * Free texture image.
* *
* \param teximage texture image. * \param texImage texture image.
* *
* Free the texture image structure and the associated image data. * Free the texture image structure and the associated image data.
*/ */
@@ -844,7 +844,7 @@ _mesa_select_tex_object(GLcontext *ctx, const struct gl_texture_unit *texUnit,
* of the given texture unit. * of the given texture unit.
* *
* \param ctx GL context. * \param ctx GL context.
* \param texUnit texture unit. * \param texObj texture unit.
* \param target texture target. * \param target texture target.
* \param level image level. * \param level image level.
* *
@@ -1852,7 +1852,6 @@ subtexture_error_check2( GLcontext *ctx, GLuint dimensions,
* \param internalFormat internal format given by the user. * \param internalFormat internal format given by the user.
* \param width image width given by the user. * \param width image width given by the user.
* \param height image height given by the user. * \param height image height given by the user.
* \param depth image depth given by the user.
* \param border texture border. * \param border texture border.
* *
* \return GL_TRUE if an error was detected, or GL_FALSE if no errors. * \return GL_TRUE if an error was detected, or GL_FALSE if no errors.

View File

@@ -180,7 +180,7 @@ finish_texture_init(GLcontext *ctx, GLenum target,
* Called via ctx->Driver.DeleteTexture() if not overriden by a driver. * Called via ctx->Driver.DeleteTexture() if not overriden by a driver.
* *
* \param shared the shared GL state to which the object belongs. * \param shared the shared GL state to which the object belongs.
* \param texOjb the texture object to delete. * \param texObj the texture object to delete.
*/ */
void void
_mesa_delete_texture_object( GLcontext *ctx, struct gl_texture_object *texObj ) _mesa_delete_texture_object( GLcontext *ctx, struct gl_texture_object *texObj )

View File

@@ -517,7 +517,7 @@ _mesa_lookup_parameter_index(const struct gl_program_parameter_list *paramList,
* swizzling to find a match. * swizzling to find a match.
* \param list the parameter list to search * \param list the parameter list to search
* \param v the float vector to search for * \param v the float vector to search for
* \param size number of element in v * \param vSize number of element in v
* \param posOut returns the position of the constant, if found * \param posOut returns the position of the constant, if found
* \param swizzleOut returns a swizzle mask describing location of the * \param swizzleOut returns a swizzle mask describing location of the
* vector elements if found. * vector elements if found.

View File

@@ -213,7 +213,7 @@ arb_output_attrib_string(GLint index, GLenum progType)
* Return string representation of the given register. * Return string representation of the given register.
* Note that some types of registers (like PROGRAM_UNIFORM) aren't defined * Note that some types of registers (like PROGRAM_UNIFORM) aren't defined
* by the ARB/NV program languages so we've taken some liberties here. * by the ARB/NV program languages so we've taken some liberties here.
* \param file the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc) * \param f the register file (PROGRAM_INPUT, PROGRAM_TEMPORARY, etc)
* \param index number of the register in the register file * \param index number of the register in the register file
* \param mode the output format/mode/style * \param mode the output format/mode/style
* \param prog pointer to containing program * \param prog pointer to containing program