diff options
author | Campbell Barton <ideasman42@gmail.com> | 2013-09-12 07:02:50 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2013-09-12 07:02:50 +0400 |
commit | 8beb565c5992e239eb0f618f9df264de821d4cf7 (patch) | |
tree | 54f26cb6daf31c826d1ae20197d6e6840be49c92 /source/blender/blenlib | |
parent | 30695da26187b9cfb3442f897394a64c4a8422fb (diff) |
code cleanup: headers - doxy comments.
Diffstat (limited to 'source/blender/blenlib')
-rw-r--r-- | source/blender/blenlib/BLI_array.h | 2 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_bitmap.h | 4 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_buffer.h | 24 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_callbacks.h | 2 | ||||
-rw-r--r-- | source/blender/blenlib/BLI_math_interp.h | 4 | ||||
-rw-r--r-- | source/blender/blenlib/intern/BLI_array.c | 2 | ||||
-rw-r--r-- | source/blender/blenlib/intern/buffer.c | 4 | ||||
-rw-r--r-- | source/blender/blenlib/intern/callbacks.c | 4 | ||||
-rw-r--r-- | source/blender/blenlib/intern/convexhull2d.c | 5 | ||||
-rw-r--r-- | source/blender/blenlib/intern/math_interp.c | 4 | ||||
-rw-r--r-- | source/blender/blenlib/intern/smallhash.c | 4 |
11 files changed, 45 insertions, 14 deletions
diff --git a/source/blender/blenlib/BLI_array.h b/source/blender/blenlib/BLI_array.h index 566fc95eb4f..4110c85c2a5 100644 --- a/source/blender/blenlib/BLI_array.h +++ b/source/blender/blenlib/BLI_array.h @@ -13,7 +13,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, - * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * The Original Code is Copyright (C) 2008 Blender Foundation. * All rights reserved. diff --git a/source/blender/blenlib/BLI_bitmap.h b/source/blender/blenlib/BLI_bitmap.h index 420ba16cbe2..bcdc97cdaa7 100644 --- a/source/blender/blenlib/BLI_bitmap.h +++ b/source/blender/blenlib/BLI_bitmap.h @@ -26,6 +26,10 @@ #ifndef __BLI_BITMAP_H__ #define __BLI_BITMAP_H__ +/** \file BLI_bitmap.h + * \ingroup bli + */ + typedef unsigned int BLI_bitmap; /* warning: the bitmap does not keep track of its own size or check diff --git a/source/blender/blenlib/BLI_buffer.h b/source/blender/blenlib/BLI_buffer.h index 461b56e157f..9c4b4b00b24 100644 --- a/source/blender/blenlib/BLI_buffer.h +++ b/source/blender/blenlib/BLI_buffer.h @@ -21,21 +21,23 @@ #ifndef __BLI_BUFFER_H__ #define __BLI_BUFFER_H__ -/* Note: this more or less fills same purpose as BLI_array, but makes +/** \file BLI_buffer.h + * \ingroup bli + * + * \note this more or less fills same purpose as BLI_array, but makes * it much easier to resize the array outside of the function it was - * declared in since */ - -/* Usage examples: + * declared in since. * - * { - * BLI_buffer_declare_static(int, my_int_array, BLI_BUFFER_NOP, 32); + * Usage examples: + * \code + * BLI_buffer_declare_static(int, my_int_array, BLI_BUFFER_NOP, 32); * - * BLI_buffer_append(my_int_array, int, 42); - * assert(my_int_array.count == 1); - * assert(BLI_buffer_at(my_int_array, int, 0) == 42); + * BLI_buffer_append(my_int_array, int, 42); + * assert(my_int_array.count == 1); + * assert(BLI_buffer_at(my_int_array, int, 0) == 42); * - * BLI_buffer_free(&my_int_array); - * } + * BLI_buffer_free(&my_int_array); + * \endcode */ typedef struct { diff --git a/source/blender/blenlib/BLI_callbacks.h b/source/blender/blenlib/BLI_callbacks.h index 4f727773cd2..8d5ea91c422 100644 --- a/source/blender/blenlib/BLI_callbacks.h +++ b/source/blender/blenlib/BLI_callbacks.h @@ -18,7 +18,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/blenlib/BLI_callbacks.h +/** \file BLI_callbacks.h * \ingroup bli */ diff --git a/source/blender/blenlib/BLI_math_interp.h b/source/blender/blenlib/BLI_math_interp.h index 543ff1bb38c..c38c61a288f 100644 --- a/source/blender/blenlib/BLI_math_interp.h +++ b/source/blender/blenlib/BLI_math_interp.h @@ -29,6 +29,10 @@ #ifndef __BLI_MATH_INTERP__ #define __BLI_MATH_INTERP__ +/** \file BLI_math_interp.h + * \ingroup bli + */ + void BLI_bicubic_interpolation_fl(const float *buffer, float *output, int width, int height, int components, float u, float v); diff --git a/source/blender/blenlib/intern/BLI_array.c b/source/blender/blenlib/intern/BLI_array.c index 510bf072513..21d7a5a6d10 100644 --- a/source/blender/blenlib/intern/BLI_array.c +++ b/source/blender/blenlib/intern/BLI_array.c @@ -13,7 +13,7 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software Foundation, - * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * The Original Code is Copyright (C) 2008 Blender Foundation. * All rights reserved. diff --git a/source/blender/blenlib/intern/buffer.c b/source/blender/blenlib/intern/buffer.c index 36fb04a7bb7..4e570823319 100644 --- a/source/blender/blenlib/intern/buffer.c +++ b/source/blender/blenlib/intern/buffer.c @@ -18,6 +18,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file blender/blenlib/intern/buffer.c + * \ingroup bli + */ + #include "MEM_guardedalloc.h" #include "BLI_buffer.h" diff --git a/source/blender/blenlib/intern/callbacks.c b/source/blender/blenlib/intern/callbacks.c index 614a9a63d90..719809e6bcd 100644 --- a/source/blender/blenlib/intern/callbacks.c +++ b/source/blender/blenlib/intern/callbacks.c @@ -20,6 +20,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file blender/blenlib/intern/callbacks.c + * \ingroup bli + */ + #include "BLI_utildefines.h" #include "BLI_listbase.h" #include "BLI_callbacks.h" diff --git a/source/blender/blenlib/intern/convexhull2d.c b/source/blender/blenlib/intern/convexhull2d.c index 536bb6d94e3..5669a302bd8 100644 --- a/source/blender/blenlib/intern/convexhull2d.c +++ b/source/blender/blenlib/intern/convexhull2d.c @@ -18,6 +18,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file blender/blenlib/intern/convexhull2d.c + * \ingroup bli + */ + + #include <stdlib.h> #include <string.h> diff --git a/source/blender/blenlib/intern/math_interp.c b/source/blender/blenlib/intern/math_interp.c index 81d931cfba6..d1acd45e40e 100644 --- a/source/blender/blenlib/intern/math_interp.c +++ b/source/blender/blenlib/intern/math_interp.c @@ -26,6 +26,10 @@ * */ +/** \file blender/blenlib/intern/math_interp.c + * \ingroup bli + */ + #include <math.h> #include "BLI_math.h" diff --git a/source/blender/blenlib/intern/smallhash.c b/source/blender/blenlib/intern/smallhash.c index 7bb0747daaa..19eb88f9e15 100644 --- a/source/blender/blenlib/intern/smallhash.c +++ b/source/blender/blenlib/intern/smallhash.c @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file blender/blenlib/intern/smallhash.c + * \ingroup bli + */ + #include <string.h> #include "MEM_guardedalloc.h" |