diff options
author | Jose Fonseca <j_r_fonseca@yahoo.co.uk> | 2003-05-18 14:11:24 +0000 |
---|---|---|
committer | Jose Fonseca <j_r_fonseca@yahoo.co.uk> | 2003-05-18 14:11:24 +0000 |
commit | ace39eb8cf4640cdad573e5f394a9950aa075f0e (patch) | |
tree | 802fa7ba485958945255c8e9d6d879109ad20b99 | |
parent | be881cdee1055f2d274332b0cf28d419b53a0335 (diff) |
Remove the kernel documention directories on the 'clean' target of doxy/makefile.
Fixed some incoherences regarding the Radeon command packects and indirect buffers and vocabulary.
Several fixes to the documentation to elimite all doxygen warnings.
24 files changed, 68 insertions, 58 deletions
diff --git a/doxygen/.cvsignore b/doxygen/.cvsignore index 4ab1a3160f..1b0edf90a6 100644 --- a/doxygen/.cvsignore +++ b/doxygen/.cvsignore @@ -1,4 +1,5 @@ *.tag +agpgart array_cache core core_subset @@ -6,6 +7,8 @@ math math_subset miniglx radeon_subset +radeondrm +radeonfb swrast swrast_setup tnl diff --git a/doxygen/makefile b/doxygen/makefile index ab391ffa29..48a6fb385a 100644 --- a/doxygen/makefile +++ b/doxygen/makefile @@ -42,6 +42,9 @@ clean: tnl_dd \
tnl \
miniglx \
- radeon_subset
+ radeon_subset \
+ radeonfb \
+ radeondrm \
+ agpgart
rm -rf *.tag
diff --git a/doxygen/math_subset.doxy b/doxygen/math_subset.doxy index 53d837df0b..5256e88d09 100644 --- a/doxygen/math_subset.doxy +++ b/doxygen/math_subset.doxy @@ -45,7 +45,7 @@ SHOW_USED_FILES = YES #--------------------------------------------------------------------------- QUIET = YES WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO WARN_FORMAT = WARN_LOGFILE = #--------------------------------------------------------------------------- diff --git a/src/mesa/drivers/common/mm.c b/src/mesa/drivers/common/mm.c index 55994dd9d7..52d024d406 100644 --- a/src/mesa/drivers/common/mm.c +++ b/src/mesa/drivers/common/mm.c @@ -69,7 +69,7 @@ void mmDumpMemInfo( memHeap_t *heap ) /** * \brief Memory heap initialization. * - * \param offset offset in bytes. + * \param ofs offset in bytes. * \param size total size in bytes * * \return a heap pointer on success, or NULL on failure. @@ -230,7 +230,7 @@ static __inline__ int Join2Blocks(TMemBlock *p) /** * \brief Free a memory block. * - * \param pointer to a block. + * \param b pointer to a block. * * \return 0 on success, or -1 on failure. * diff --git a/src/mesa/drivers/dri/common/mm.c b/src/mesa/drivers/dri/common/mm.c index 55994dd9d7..52d024d406 100644 --- a/src/mesa/drivers/dri/common/mm.c +++ b/src/mesa/drivers/dri/common/mm.c @@ -69,7 +69,7 @@ void mmDumpMemInfo( memHeap_t *heap ) /** * \brief Memory heap initialization. * - * \param offset offset in bytes. + * \param ofs offset in bytes. * \param size total size in bytes * * \return a heap pointer on success, or NULL on failure. @@ -230,7 +230,7 @@ static __inline__ int Join2Blocks(TMemBlock *p) /** * \brief Free a memory block. * - * \param pointer to a block. + * \param b pointer to a block. * * \return 0 on success, or -1 on failure. * diff --git a/src/mesa/drivers/dri/radeon/radeon_context.c b/src/mesa/drivers/dri/radeon/radeon_context.c index 7ea650d42c..147764f5e8 100644 --- a/src/mesa/drivers/dri/radeon/radeon_context.c +++ b/src/mesa/drivers/dri/radeon/radeon_context.c @@ -101,7 +101,7 @@ static void radeonGetBufferSize( GLframebuffer *buffer, * \param ctx GL context. * \param name name of the string to return. * - * \param pointer to a static string describing the aspect specified by \p + * \return pointer to a static string describing the aspect specified by \p * name. * * \sa glGetString(). diff --git a/src/mesa/drivers/dri/radeon/radeon_context.h b/src/mesa/drivers/dri/radeon/radeon_context.h index eacefb19a7..16170e718c 100644 --- a/src/mesa/drivers/dri/radeon/radeon_context.h +++ b/src/mesa/drivers/dri/radeon/radeon_context.h @@ -232,24 +232,29 @@ struct radeon_texture_state { /** * \brief Radeon state atom double-linked list. + * + * The state information is the actual command packet. */ struct radeon_state_atom { struct radeon_state_atom *next, *prev; const char *name; /**< \brief for debugging purposes */ int cmd_size; /**< \brief size in bytes */ GLuint is_tcl; /**< \brief whether is associated with TCL */ - int *cmd; /**< \brief one or more cmd's */ - int *lastcmd; /**< \brief one or more cmd's */ + int *cmd; /**< \brief one or more command packets */ + int *lastcmd; /**< \brief one or more command packets */ GLboolean (*check)( GLcontext * ); /**< \brief callback to determin whether this state is active */ }; - -/* Trying to keep these relatively short as the variables are becoming - * extravagently long. Drop the RADEON_ off the front of everything - - * I think we know we're in the radeon driver by now, and keep the - * prefix to 3 letters unless absolutely impossible. +/** + * \name Indices for the command packets fields + * + * \note Trying to keep these relatively short as the variables are becoming + * extravagently long. Drop the RADEON_ off the front of everything - I think + * we know we're in the radeon driver by now, and keep the prefix to 3 letters + * unless absolutely impossible. */ +/*@{*/ #define CTX_CMD_0 0 #define CTX_PP_MISC 1 @@ -442,6 +447,8 @@ struct radeon_state_atom { #define SHN_SHININESS 1 #define SHN_STATE_SIZE 2 +/*@}*/ + /** * \brief Hardware state management. @@ -734,7 +741,7 @@ struct radeon_context { * * \param cpp desired characters (bytes) per pixel. Shouble be either 2 or 4. * \param r red color component. - * \param r green color component. + * \param g green color component. * \param b blue color component. * \param a alpha color component. * diff --git a/src/mesa/drivers/dri/radeon/radeon_state.c b/src/mesa/drivers/dri/radeon/radeon_state.c index 1277fce8f0..713391a764 100644 --- a/src/mesa/drivers/dri/radeon/radeon_state.c +++ b/src/mesa/drivers/dri/radeon/radeon_state.c @@ -1044,6 +1044,7 @@ void radeonUpdateWindow( GLcontext *ctx ) /** * \brief Set the viewport. * + * \param ctx GL context. * \param x \e x position of the lower left corner of the viewport rectangle. * Not used. * \param y \e y position of the lower left corner of the viewport rectangle. @@ -1287,6 +1288,7 @@ static void radeonReadBuffer( GLcontext *ctx, GLenum mode ) /** * \brief Enable or disable a GL capability. * + * \param ctx GL context. * \param cap GL capability. * \param state whether to enable or disable the capability. * diff --git a/src/mesa/drivers/dri/radeon/radeon_state_init.c b/src/mesa/drivers/dri/radeon/radeon_state_init.c index 20a568a007..8808a73ee1 100644 --- a/src/mesa/drivers/dri/radeon/radeon_state_init.c +++ b/src/mesa/drivers/dri/radeon/radeon_state_init.c @@ -73,7 +73,7 @@ void radeonPrintDirty( radeonContextPtr rmesa, const char *msg ) /** * \brief Constructs a register packet command. * - * \param register ID. + * \param id register ID. * \return integer equivalent of the command. * * \sa drmRadeonCmdHeader and drmRadeonCmdType::RADEON_CMD_PACKET. diff --git a/src/mesa/drivers/dri/radeon/radeon_subset_bitmap.c b/src/mesa/drivers/dri/radeon/radeon_subset_bitmap.c index 9f01bd6a04..7593ce444e 100644 --- a/src/mesa/drivers/dri/radeon/radeon_subset_bitmap.c +++ b/src/mesa/drivers/dri/radeon/radeon_subset_bitmap.c @@ -53,12 +53,12 @@ /** * \brief Cope with depth operations by drawing individual pixels as points * - * \param ctx GL context. - * \param px x coordinate of the bitmap corner. - * \param py y coordinate of the bitmap corner. + * \param xorig x coordinate of the bitmap corner. + * \param yorig y coordinate of the bitmap corner. + * \param xmove increment to the final x coordinate. + * \param ymove increment to the final y coordinate. * \param width bitmap width. * \param height bitmap height. - * \param unpack unpacking pixel attributes. * \param bitmap bitmap pointer. * * Clips the bitmap coordinates and adjusts for windows coordinates. Draws the diff --git a/src/mesa/drivers/dri/radeon/radeon_subset_readpix.c b/src/mesa/drivers/dri/radeon/radeon_subset_readpix.c index 7b54d4ad15..330aca2895 100644 --- a/src/mesa/drivers/dri/radeon/radeon_subset_readpix.c +++ b/src/mesa/drivers/dri/radeon/radeon_subset_readpix.c @@ -137,15 +137,13 @@ static void ReadRGBASpan( const GLcontext *ctx, * To be used with particular pixel formats GL_UNSIGNED_BYTE and GL_RGBA, when pixel * scaling, biasing and mapping are disabled. * - * \param ctx GL context. * \param x x start position of the reading rectangle. * \param y y start position of the reading rectangle. * \param width width of the reading rectangle. * \param height height of the reading recatangle. * \param format pixel format. Must be GL_RGBA. - * \param format pixel type. Must be GL_UNSIGNED_BYTE. - * \param packing packing attributes. Must specify byte alignment and no byte - * swaping or LSB ordering. + * \param type pixel type. Must be GL_UNSIGNED_BYTE. + * \param pixels pixel data. * * After asserting the above conditions, compensates for clipping and calls * ReadRGBASpan() to read each row. diff --git a/src/mesa/drivers/dri/radeon/radeon_subset_select.c b/src/mesa/drivers/dri/radeon/radeon_subset_select.c index 5036531311..25ff28d8ed 100644 --- a/src/mesa/drivers/dri/radeon/radeon_subset_select.c +++ b/src/mesa/drivers/dri/radeon/radeon_subset_select.c @@ -27,7 +27,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: radeon_subset_select.c,v 1.1.2.7 2003/04/27 14:21:22 keithw Exp $ */ +/* $Id: radeon_subset_select.c,v 1.1.2.8 2003/05/18 14:11:28 jrfonseca Exp $ */ #include "glheader.h" @@ -560,6 +560,7 @@ select_triangle(const vertex *v0, * \param x x vertex coordinate. * \param y y vertex coordinate. * \param z z vertex coordinate. + * \param w homogeneous coordinate. * * Stores the vertex and current attributes in ::vb, transforms it into eye space and then clip space. * @@ -995,5 +996,3 @@ void radeonInitSelect( GLcontext *ctx ) { ctx->Driver.RenderMode = radeonRenderMode; } - -/*@}*/ diff --git a/src/mesa/drivers/dri/radeon/radeon_subset_tex.c b/src/mesa/drivers/dri/radeon/radeon_subset_tex.c index ce94aa1fd7..afbeda13de 100644 --- a/src/mesa/drivers/dri/radeon/radeon_subset_tex.c +++ b/src/mesa/drivers/dri/radeon/radeon_subset_tex.c @@ -803,7 +803,7 @@ static void radeonTexImage2D( GLcontext *ctx, GLenum target, GLint level, * \param ctx GL context. * \param target texture environment. * \param pname texture parameter. Accepted value is GL_TEXTURE_ENV_COLOR. - * \param pvalue texture value. + * \param param parameter value. * * Updates the current unit's RADEON_TEX_PP_TFACTOR register and informs of the * state change. diff --git a/src/mesa/drivers/dri/radeon/server/radeon_common.h b/src/mesa/drivers/dri/radeon/server/radeon_common.h index bd808d124b..a4d0258d1a 100644 --- a/src/mesa/drivers/dri/radeon/server/radeon_common.h +++ b/src/mesa/drivers/dri/radeon/server/radeon_common.h @@ -416,7 +416,7 @@ enum drmRadeonCmdType { } ; /** - * \brief Commands understood by the DRM_RADEON_CMDBUF ioctl. + * \brief Command packet headers understood by the DRM_RADEON_CMDBUF ioctl. * * \sa drmRadeonCmdType. */ diff --git a/src/mesa/drivers/dri/radeon/server/radeon_dri.c b/src/mesa/drivers/dri/radeon/server/radeon_dri.c index 298f646773..8d36e449bf 100644 --- a/src/mesa/drivers/dri/radeon/server/radeon_dri.c +++ b/src/mesa/drivers/dri/radeon/server/radeon_dri.c @@ -949,7 +949,7 @@ static int RADEONScreenInit( struct DRIDriverContextRec *ctx, RADEONInfoPtr info /** * \brief Get Radeon chip family from chipset number. * - * \param driver private data. + * \param info driver private data. * * \return non-zero on sucess, or zero on failure. * diff --git a/src/mesa/main/context.c b/src/mesa/main/context.c index 42e5be8952..cc6b97f6a3 100644 --- a/src/mesa/main/context.c +++ b/src/mesa/main/context.c @@ -28,7 +28,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: context.c,v 1.188.2.1.2.17 2003/04/29 08:20:39 keithw Exp $ */ +/* $Id: context.c,v 1.188.2.1.2.18 2003/05/18 14:11:24 jrfonseca Exp $ */ /** * \mainpage Mesa Core Module @@ -220,6 +220,7 @@ _mesa_makeCurrent(__GLcontext *gc) * \brief Share context callback. * * \param gc context. + * \param gcShare shared context. * \return GL_TRUE on success, or GL_FALSE on failure. * * \ifnot subset @@ -427,13 +428,14 @@ __glCoreNopDispatch(void) * is acceptable but the actual depth type will be GLushort or GLuint as * needed. * \param stencilBits requested minimum bits per stencil buffer value - * \param accumBits requested minimum bits per accum buffer component + * \param accumRedBits, accumGreenBits, accumBlueBits, accumAlphaBits number of bits per color component in accum buffer. * \param indexBits number of bits per pixel if \p rgbFlag is GL_FALSE - * \param red number of bits per color component in frame buffer for RGB(A) + * \param redBits number of bits per color component in frame buffer for RGB(A) * mode. We always use 8 in core Mesa though. - * \param green same as above. - * \param blue same as above. + * \param greenBits same as above. + * \param blueBits same as above. * \param alphaBits same as above. + * \param numSamples not really used. * * \return pointer to new GLvisual or NULL if requested parameters can't be * met. @@ -1020,9 +1022,7 @@ init_attrib_groups( GLcontext *ctx ) * This includes allocating all the other structs and arrays which hang off of * the context by pointers. * - * \param ctx GL context. - * - * \sa _mesa_create_context() for the remaining parameter description. + * \sa _mesa_create_context() for the parameter description. * * Performs the imports and exports callback tables initialzation, and * miscellaenuos one-time initializations. If no shared context is supplied one @@ -1120,7 +1120,7 @@ _mesa_initialize_context( GLcontext *ctx, * \brief Allocate and initialize a GLcontext structure. * * \param visual a GLvisual pointer (we copy the struct contents) - * \param sharelist another context to share display lists with or NULL + * \param share_list another context to share display lists with or NULL * \param driver_ctx pointer to device driver's context state struct * \param direct direct rendering? * diff --git a/src/mesa/main/dd.h b/src/mesa/main/dd.h index 2efc27cb19..bf96b6a3dc 100644 --- a/src/mesa/main/dd.h +++ b/src/mesa/main/dd.h @@ -27,7 +27,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: dd.h,v 1.74.6.6 2003/03/23 23:22:47 jrfonseca Exp $ */ +/* $Id: dd.h,v 1.74.6.7 2003/05/18 14:11:25 jrfonseca Exp $ */ #ifndef DD_INCLUDED @@ -530,7 +530,6 @@ struct dd_function_table { /** * \name Imaging functionality - * . */ /*@{*/ void (*CopyColorTable)( GLcontext *ctx, @@ -842,7 +841,6 @@ struct dd_function_table { typedef struct { /** * \name Vertex - * . */ /*@{*/ void (*ArrayElement)( GLint ); /* NOTE */ diff --git a/src/mesa/main/glheader.h b/src/mesa/main/glheader.h index c918384a3f..8a022f6973 100644 --- a/src/mesa/main/glheader.h +++ b/src/mesa/main/glheader.h @@ -4,7 +4,7 @@ * * This is the top-most include file of the Mesa sources. * It includes gl.h and all system headers which are needed. - * Other Mesa source files should \u not directly include any system + * Other Mesa source files should \e not directly include any system * headers. This allows Mesa to be integrated into XFree86 and * allows system-dependent hacks/work-arounds to be collected in one place. * @@ -40,7 +40,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: glheader.h,v 1.29.4.2 2003/03/23 03:51:34 jrfonseca Exp $ */ +/* $Id: glheader.h,v 1.29.4.3 2003/05/18 14:11:25 jrfonseca Exp $ */ #ifndef GLHEADER_H diff --git a/src/mesa/main/hash.c b/src/mesa/main/hash.c index 793bd9911a..6a84b1eae3 100644 --- a/src/mesa/main/hash.c +++ b/src/mesa/main/hash.c @@ -34,7 +34,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: hash.c,v 1.14.4.2 2003/03/23 23:22:48 jrfonseca Exp $ */ +/* $Id: hash.c,v 1.14.4.3 2003/05/18 14:11:26 jrfonseca Exp $ */ #include "glheader.h" #include "imports.h" @@ -234,7 +234,7 @@ void _mesa_HashRemove(struct _mesa_HashTable *table, GLuint key) /** - * \param Get the key of the "first" entry in the hash table. + * \brief Get the key of the "first" entry in the hash table. * * This is used in the course of deleting all display lists when * a context is destroyed. @@ -284,7 +284,7 @@ void _mesa_HashPrint(const struct _mesa_HashTable *table) /** - * \param Find a block of adjacent unused hash keys. + * \brief Find a block of adjacent unused hash keys. * * \param table the hash table. * \param numKeys number of keys needed. diff --git a/src/mesa/main/macros.h b/src/mesa/main/macros.h index dfda63c95e..80dd10672b 100644 --- a/src/mesa/main/macros.h +++ b/src/mesa/main/macros.h @@ -27,7 +27,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: macros.h,v 1.30.4.1 2003/03/20 12:56:58 jrfonseca Exp $ */ +/* $Id: macros.h,v 1.30.4.2 2003/05/18 14:11:26 jrfonseca Exp $ */ #ifndef MACROS_H @@ -39,7 +39,7 @@ */ -/* Limits: */ +/* Limits */ #define MAX_GLUSHORT 0xffff #define MAX_GLUINT 0xffffffff diff --git a/src/mesa/main/matrix.c b/src/mesa/main/matrix.c index d4acd1d857..ff78c026bf 100644 --- a/src/mesa/main/matrix.c +++ b/src/mesa/main/matrix.c @@ -32,7 +32,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: matrix.c,v 1.45.4.8 2003/03/24 18:23:32 keithw Exp $ */ +/* $Id: matrix.c,v 1.45.4.9 2003/05/18 14:11:26 jrfonseca Exp $ */ #include "glheader.h" @@ -136,7 +136,7 @@ _mesa_Ortho( GLdouble left, GLdouble right, /** * \brief Set the current matrix stack. * - * \param nome matrix stack. + * \param mode matrix stack. * * \sa glMatrixMode(). * diff --git a/src/mesa/main/mtypes.h b/src/mesa/main/mtypes.h index 91e79c01fd..dcbf442a6a 100644 --- a/src/mesa/main/mtypes.h +++ b/src/mesa/main/mtypes.h @@ -29,7 +29,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: mtypes.h,v 1.97.4.9 2003/03/23 23:22:48 jrfonseca Exp $ */ +/* $Id: mtypes.h,v 1.97.4.10 2003/05/18 14:11:26 jrfonseca Exp $ */ #ifndef TYPES_H @@ -205,7 +205,6 @@ struct gl_color_table { /** * \name Bit flags used for updating material values. - * . */ /*@{*/ #define FRONT_AMBIENT_BIT 0x1 @@ -1826,7 +1825,7 @@ struct matrix_stack /** * \name Bits for __GLcontextRec::_NeedEyeCoords. - * . + * */ /*@{*/ #define NEED_EYE_TEXGEN 0x1 @@ -2208,7 +2207,6 @@ do { \ * glBegin()/glEnd() pair and flush the vertices. * * \param ctx GL context. - * \param retval value to return value in case the assertation fails. */ #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx) \ do { \ diff --git a/src/mesa/main/rastpos.c b/src/mesa/main/rastpos.c index 4addced71c..92cd77e9b1 100644 --- a/src/mesa/main/rastpos.c +++ b/src/mesa/main/rastpos.c @@ -27,7 +27,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: rastpos.c,v 1.39.4.8 2003/03/23 14:58:08 jrfonseca Exp $ */ +/* $Id: rastpos.c,v 1.39.4.9 2003/05/18 14:11:27 jrfonseca Exp $ */ #include "glheader.h" @@ -89,6 +89,7 @@ viewclip_point_z( const GLfloat v[] ) /** * \brief Clip a point against the user clipping planes. * + * \param ctx GL context. * \param v vertex vector describing the point to clip. * * \return zero if the point was clipped, or one otherwise. @@ -284,6 +285,7 @@ shade_rastpos(GLcontext *ctx, /** * \brief Set the raster position for pixel operations. * + * \param ctx GL context. * \param x x coordinate for the raster position. * \param y y coordinate for the raster position. * \param z z coordinate for the raster position. diff --git a/src/mesa/main/simple_list.h b/src/mesa/main/simple_list.h index e18932f913..c855408aec 100644 --- a/src/mesa/main/simple_list.h +++ b/src/mesa/main/simple_list.h @@ -33,7 +33,7 @@ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -/* $Id: simple_list.h,v 1.2.8.1 2003/03/20 19:38:46 jrfonseca Exp $ */ +/* $Id: simple_list.h,v 1.2.8.2 2003/05/18 14:11:27 jrfonseca Exp $ */ #ifndef _SIMPLE_LIST_H @@ -105,7 +105,7 @@ do { \ /** * \brief Make a empty list empty. * - * \param sentinel list (sentinal element). + * \param sentinal list (sentinal element). */ #define make_empty_list(sentinal) \ do { \ |