style cleanup

- spelling - turns out we had tessellation spelt wrong all over.
- use \directive for doxy (not @directive)
- remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.

6 files changed, 91 insertions, 92 deletions

diff --git a/source/blender/imbuf/IMB_imbuf.h b/source/blender/imbuf/IMB_imbuf.h
index ee1580a3135..c96b0509a27 100644
--- a/source/blender/imbuf/IMB_imbuf.h
+++ b/source/blender/imbuf/IMB_imbuf.h
@@ -30,23 +30,22 @@
  */
 
 /**
- * @file IMB_imbuf.h
- * @brief IMage Buffer module.
+ * \brief IMage Buffer module.
  *
  * This module offers import/export of several graphical file formats.
- * @ingroup imbuf
+ * \ingroup imbuf
  *
- * @page IMB Imbuf module external interface
+ * \page IMB Imbuf module external interface
  *
  *
- * @section about About the IMB module
+ * \section about About the IMB module
  *
  * External interface of the IMage Buffer module. This module offers
  * import/export of several graphical file formats. It offers the
  * ImBuf type as a common structure to refer to different graphical
  * file formats, and to enable a uniform way of handling them.
  *
- * @section issues Known issues with IMB
+ * \section issues Known issues with IMB
  *
  * - imbuf is written in C.
  * - Endianness issues are dealt with internally.
@@ -56,7 +55,7 @@
  *   amiga and Irix are present. A 'posix-compliancy-patch'
  *   provides the interface to windows.
  *
- * @section dependencies Dependencies
+ * \section dependencies Dependencies
  *
  * IMB needs:
  * - \ref DNA module
@@ -73,51 +72,51 @@
 
 /**
  *
- * @attention defined in ???
+ * \attention defined in ???
  */
 struct ImBuf;
 
 /**
  *
- * @attention defined in ???
+ * \attention defined in ???
  */
 struct anim;
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 void IMB_init(void);
 void IMB_exit(void);
 
 /**
  *
- * @attention Defined in readimage.c
+ * \attention Defined in readimage.c
  */
 struct ImBuf *IMB_ibImageFromMemory(unsigned char *mem, size_t size,
                                     int flags, const char *descr);
 
 /**
  *
- * @attention Defined in readimage.c
+ * \attention Defined in readimage.c
  */
 struct ImBuf *IMB_testiffname(const char *filepath, int flags);
 
 /**
  *
- * @attention Defined in readimage.c
+ * \attention Defined in readimage.c
  */
 struct ImBuf *IMB_loadiffname(const char *filepath, int flags);
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 void IMB_freeImBuf(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y,
                              unsigned char d, unsigned int flags);
@@ -128,7 +127,7 @@ struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y,
  * (to delete an imbuf you have to call freeImBuf as many times as it
  * is referenced)
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 
 void IMB_refImBuf(struct ImBuf *ibuf);
@@ -136,20 +135,20 @@ struct ImBuf * IMB_makeSingleUser(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 short addzbufImBuf(struct ImBuf *ibuf);
 short addzbuffloatImBuf(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in rectop.c
+ * \attention Defined in rectop.c
  */
 
 typedef enum IMB_BlendMode {
@@ -181,7 +180,7 @@ void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *sbuf, int destx,
 
 /**
  *
- * @attention Defined in indexer.c
+ * \attention Defined in indexer.c
  */
 
 typedef enum IMB_Timecode_Type {
@@ -231,7 +230,7 @@ void IMB_anim_index_rebuild(struct IndexBuildContext *context,
 void IMB_anim_index_rebuild_finish(struct IndexBuildContext *context, short stop);
 
 /**
- * Return the length (in frames) of the given @a anim.
+ * Return the length (in frames) of the given \a anim.
  */
 int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc);
 
@@ -245,7 +244,7 @@ int IMB_anim_get_fps(struct anim * anim,
 
 /**
  *
- * @attention Defined in anim_movie.c
+ * \attention Defined in anim_movie.c
  */
 struct anim *IMB_open_anim(const char *name, int ib_flags, int streamindex);
 void IMB_close_anim(struct anim *anim);
@@ -254,7 +253,7 @@ void IMB_close_anim_proxies(struct anim *anim);
 
 /**
  *
- * @attention Defined in anim_movie.c
+ * \attention Defined in anim_movie.c
  */
 
 int ismovie(const char *filepath);
@@ -263,7 +262,7 @@ int IMB_anim_get_preseek(struct anim *anim);
 
 /**
  *
- * @attention Defined in anim_movie.c
+ * \attention Defined in anim_movie.c
  */
 
 struct ImBuf *IMB_anim_absolute(
@@ -273,20 +272,20 @@ struct ImBuf *IMB_anim_absolute(
 
 /**
  *
- * @attention Defined in anim_movie.c
+ * \attention Defined in anim_movie.c
  * fetches a define previewframe, usually half way into the movie
  */
 struct ImBuf *IMB_anim_previewframe(struct anim *anim);
 
 /**
  *
- * @attention Defined in anim_movie.c
+ * \attention Defined in anim_movie.c
  */
 void IMB_free_anim(struct anim *anim);
 
 /**
  *
- * @attention Defined in filter.c
+ * \attention Defined in filter.c
  */
 
 #define FILTER_MASK_NULL		0
@@ -304,7 +303,7 @@ struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level);
 
 /**
  *
- * @attention Defined in cache.c
+ * \attention Defined in cache.c
  */
 
 void IMB_tile_cache_params(int totthread, int maxmem);
@@ -313,55 +312,55 @@ void IMB_tiles_to_rect(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in filter.c
+ * \attention Defined in filter.c
  */
 void IMB_filtery(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in scaling.c
+ * \attention Defined in scaling.c
  */
 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention Defined in scaling.c
+ * \attention Defined in scaling.c
  */
 struct ImBuf *IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
 
 /**
  *
- * @attention Defined in scaling.c
+ * \attention Defined in scaling.c
  */
 struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
 
 /**
  *
- * @attention Defined in writeimage.c
+ * \attention Defined in writeimage.c
  */
 short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags);
 
 /**
  *
- * @attention Defined in util.c
+ * \attention Defined in util.c
  */
 int IMB_ispic(const char *name);
 
 /**
  *
- * @attention Defined in util.c
+ * \attention Defined in util.c
  */
 int IMB_isanim(const char *name);
 
 /**
  *
- * @attention Defined in util.c
+ * \attention Defined in util.c
  */
 int imb_get_anim_type(const char *name);
 
 /**
  *
- * @attention Defined in divers.c
+ * \attention Defined in divers.c
  */
 void IMB_de_interlace(struct ImBuf *ibuf);
 void IMB_interlace(struct ImBuf *ibuf);
@@ -397,13 +396,13 @@ void IMB_buffer_float_clamp(float *buf, int width, int height);
  * Change the ordering of the color bytes pointed to by rect from
  * rgba to abgr. size * 4 color bytes are reordered.
  *
- * @attention Defined in imageprocess.c
+ * \attention Defined in imageprocess.c
  */
 void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);
 
 /**
  *
- * @attention defined in imageprocess.c
+ * \attention defined in imageprocess.c
  */
 void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
 void neareast_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
@@ -416,51 +415,51 @@ void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char *col, flo
 
 /**
  *
- * @attention defined in readimage.c
- * @deprecated Only here for backwards compatibility of the
- * @deprecated plugin system.
+ * \attention defined in readimage.c
+ * \deprecated Only here for backwards compatibility of the
+ * \deprecated plugin system.
  */  
 struct ImBuf *IMB_loadifffile(int file, int flags, const char *descr);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention defined in scaling.c
+ * \attention defined in scaling.c
  */
 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
 
 /**
  *
- * @attention Defined in rotate.c
+ * \attention Defined in rotate.c
  */
 void IMB_flipx(struct ImBuf *ibuf);
 void IMB_flipy(struct ImBuf *ibuf);
@@ -471,14 +470,14 @@ void IMB_premultiply_alpha(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in allocimbuf.c
+ * \attention Defined in allocimbuf.c
  */
 void IMB_freezbufImBuf(struct ImBuf *ibuf);
 void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);
 
 /**
  *
- * @attention Defined in rectop.c
+ * \attention Defined in rectop.c
  */
 void IMB_rectfill(struct ImBuf *drect, const float col[4]);
 void IMB_rectfill_area(struct ImBuf *ibuf, float *col, int x1, int y1, int x2, int y2);
diff --git a/source/blender/imbuf/intern/IMB_metadata.h b/source/blender/imbuf/intern/IMB_metadata.h
index 3ae1015d6af..8211896b185 100644
--- a/source/blender/imbuf/intern/IMB_metadata.h
+++ b/source/blender/imbuf/intern/IMB_metadata.h
@@ -55,28 +55,28 @@ typedef struct ImMetaData {
 void IMB_metadata_free(struct ImBuf* img);
 
 /** read the field from the image info into the field 
- *  @param img - the ImBuf that contains the image data
- *  @param key - the key of the field
- *  @param value - the data in the field, first one found with key is returned, 
+ *  \param img - the ImBuf that contains the image data
+ *  \param key - the key of the field
+ *  \param value - the data in the field, first one found with key is returned, 
 				  memory has to be allocated by user.
- *  @param len - length of value buffer allocated by user.
- *  @return    - 1 (true) if ImageInfo present and value for the key found, 0 (false) otherwise
+ *  \param len - length of value buffer allocated by user.
+ *  \return    - 1 (true) if ImageInfo present and value for the key found, 0 (false) otherwise
  */
 int IMB_metadata_get_field(struct ImBuf* img, const char* key, char* value, int len);
 
 /** set user data in the ImMetaData struct, which has to be allocated with IMB_metadata_create
  *  before calling this function.
- *  @param img - the ImBuf that contains the image data
- *  @param key - the key of the field
- *  @param value - the data to be written to the field. zero terminated string
- *  @return    - 1 (true) if ImageInfo present, 0 (false) otherwise
+ *  \param img - the ImBuf that contains the image data
+ *  \param key - the key of the field
+ *  \param value - the data to be written to the field. zero terminated string
+ *  \return    - 1 (true) if ImageInfo present, 0 (false) otherwise
  */
 int IMB_metadata_add_field(struct ImBuf* img, const char* key, const char* value);
 
 /** delete the key/field par in the ImMetaData struct.
- * @param img - the ImBuf that contains the image data
- * @param key - the key of the field
- * @return - 1 (true) if delete the key/field, 0 (false) otherwise
+ * \param img - the ImBuf that contains the image data
+ * \param key - the key of the field
+ * \return - 1 (true) if delete the key/field, 0 (false) otherwise
  */
 int IMB_metadata_del_field(struct ImBuf *img, const char *key);
 
diff --git a/source/blender/imbuf/intern/dds/PixelFormat.h b/source/blender/imbuf/intern/dds/PixelFormat.h
index 9add62c4616..3c5cb34812c 100644
--- a/source/blender/imbuf/intern/dds/PixelFormat.h
+++ b/source/blender/imbuf/intern/dds/PixelFormat.h
@@ -63,7 +63,7 @@
 	namespace PixelFormat
 	{
 
-		// Convert component @a c having @a inbits to the returned value having @a outbits.
+		// Convert component \a c having \a inbits to the returned value having \a outbits.
 		inline uint convert(uint c, uint inbits, uint outbits)
 		{
 			if (inbits == 0)
diff --git a/source/blender/imbuf/intern/imbuf_cocoa.m b/source/blender/imbuf/intern/imbuf_cocoa.m
index b79b1358ec2..db7f93423cb 100644
--- a/source/blender/imbuf/intern/imbuf_cocoa.m
+++ b/source/blender/imbuf/intern/imbuf_cocoa.m
@@ -53,12 +53,12 @@
  * Loads any Core Graphics supported type
  * Currently is : TIFF, BMP, JPEG, GIF, PNG, DIB, ICO, and various RAW formats
  *
- * @param mem:   Memory containing the bitmap image
- * @param size:  Size of the mem buffer.
- * @param flags: If flags has IB_test set then the file is not actually loaded,
+ * \param mem:   Memory containing the bitmap image
+ * \param size:  Size of the mem buffer.
+ * \param flags: If flags has IB_test set then the file is not actually loaded,
  *                but all other operations take place.
  *
- * @return: A newly allocated ImBuf structure if successful, otherwise NULL.
+ * \return: A newly allocated ImBuf structure if successful, otherwise NULL.
  */
 struct ImBuf *imb_cocoaLoadImage(unsigned char *mem, int size, int flags)
 {
@@ -197,11 +197,11 @@ struct ImBuf *imb_cocoaLoadImage(unsigned char *mem, int size, int flags)
  *
  * Accepted formats: TIFF, GIF, BMP, PNG, JPEG, JPEG2000
  *
- * @param ibuf:  Image buffer.
- * @param name:  Name of the image file to create.
- * @param flags: Currently largely ignored.
+ * \param ibuf:  Image buffer.
+ * \param name:  Name of the image file to create.
+ * \param flags: Currently largely ignored.
  *
- * @return: 1 if the function is successful, 0 on failure.
+ * \return: 1 if the function is successful, 0 on failure.
  */
 
 #define FTOUSHORT(val) ((val >= 1.0f-0.5f/65535)? 65535: (val <= 0.0f)? 0: (unsigned short)(val*65535.0f + 0.5f))
diff --git a/source/blender/imbuf/intern/openexr/openexr_api.h b/source/blender/imbuf/intern/openexr/openexr_api.h
index 2b3a17ba47d..0d51461c2e8 100644
--- a/source/blender/imbuf/intern/openexr/openexr_api.h
+++ b/source/blender/imbuf/intern/openexr/openexr_api.h
@@ -41,7 +41,7 @@ extern "C" {
   
   /**
  * Test presence of OpenEXR file.
- * @param mem pointer to loaded OpenEXR bitstream
+ * \param mem pointer to loaded OpenEXR bitstream
  */
   
 int		imb_is_a_openexr			(unsigned char *mem);
diff --git a/source/blender/imbuf/intern/tiff.c b/source/blender/imbuf/intern/tiff.c
index 6fe2a3b8bc2..afc64e1a528 100644
--- a/source/blender/imbuf/intern/tiff.c
+++ b/source/blender/imbuf/intern/tiff.c
@@ -113,11 +113,11 @@ static int imb_tiff_DummyMapProc(thandle_t fd, tdata_t* pbase, toff_t* psize)
 /**
  * Reads data from an in-memory TIFF file.
  *
- * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
- * @param data:   Buffer to contain data (treat as void*).
- * @param n:      Number of bytes to read.
+ * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
+ * \param data:   Buffer to contain data (treat as void*).
+ * \param n:      Number of bytes to read.
  *
- * @return: Number of bytes actually read.
+ * \return: Number of bytes actually read.
  * 	 0 = EOF.
  */
 static tsize_t imb_tiff_ReadProc(thandle_t handle, tdata_t data, tsize_t n)
@@ -177,15 +177,15 @@ static tsize_t imb_tiff_WriteProc(thandle_t handle, tdata_t data, tsize_t n)
 /**
  * Seeks to a new location in an in-memory TIFF file.
  *
- * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
- * @param ofs:    Offset value (interpreted according to whence below).
- * @param whence: This can be one of three values:
+ * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
+ * \param ofs:    Offset value (interpreted according to whence below).
+ * \param whence: This can be one of three values:
  * 	SEEK_SET - The offset is set to ofs bytes.
  * 	SEEK_CUR - The offset is set to its current location plus ofs bytes.
  * 	SEEK_END - (This is unsupported and will return -1, indicating an
  * 	            error).
  *
- * @return: Resulting offset location within the file, measured in bytes from
+ * \return: Resulting offset location within the file, measured in bytes from
  *          the beginning of the file.  (-1) indicates an error.
  */
 static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence)
@@ -231,9 +231,9 @@ static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence)
  *       are made to access the file after that point.  However, no such
  *       attempts should ever be made (in theory).
  *
- * @param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
+ * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile).
  *
- * @return: 0
+ * \return: 0
  */
 static int imb_tiff_CloseProc(thandle_t handle)
 {
@@ -259,7 +259,7 @@ static int imb_tiff_CloseProc(thandle_t handle)
 /**
  * Returns the size of an in-memory TIFF file in bytes.
  *
- * @return: Size of file (in bytes).
+ * \return: Size of file (in bytes).
  */
 static toff_t imb_tiff_SizeProc(thandle_t handle)
 {
@@ -495,12 +495,12 @@ void imb_inittiff(void)
  * Loads a TIFF file.
  *
  *
- * @param mem:   Memory containing the TIFF file.
- * @param size:  Size of the mem buffer.
- * @param flags: If flags has IB_test set then the file is not actually loaded,
+ * \param mem:   Memory containing the TIFF file.
+ * \param size:  Size of the mem buffer.
+ * \param flags: If flags has IB_test set then the file is not actually loaded,
  *                but all other operations take place.
  *
- * @return: A newly allocated ImBuf structure if successful, otherwise NULL.
+ * \return: A newly allocated ImBuf structure if successful, otherwise NULL.
  */
 ImBuf *imb_loadtiff(unsigned char *mem, size_t size, int flags)
 {
@@ -661,11 +661,11 @@ void imb_loadtiletiff(ImBuf *ibuf, unsigned char *mem, size_t size, int tx, int
  * Blender by setting "Premul" alpha handling.  Other alpha conventions are
  * not strictly correct, but are permitted anyhow.
  *
- * @param ibuf:  Image buffer.
- * @param name:  Name of the TIFF file to create.
- * @param flags: Currently largely ignored.
+ * \param ibuf:  Image buffer.
+ * \param name:  Name of the TIFF file to create.
+ * \param flags: Currently largely ignored.
  *
- * @return: 1 if the function is successful, 0 on failure.
+ * \return: 1 if the function is successful, 0 on failure.
  */
 
 int imb_savetiff(ImBuf *ibuf, const char *name, int flags)