[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [34966] trunk/blender: doxygen: add blenlib under core as module.
Nathan Letwory
nathan at letworyinteractive.com
Fri Feb 18 14:58:10 CET 2011
Revision: 34966
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=34966
Author: jesterking
Date: 2011-02-18 13:58:08 +0000 (Fri, 18 Feb 2011)
Log Message:
-----------
doxygen: add blenlib under core as module.
Modified Paths:
--------------
trunk/blender/doc/Doxyfile
trunk/blender/source/blender/blenlib/BLI_args.h
trunk/blender/source/blender/blenlib/BLI_blenlib.h
trunk/blender/source/blender/blenlib/BLI_boxpack2d.h
trunk/blender/source/blender/blenlib/BLI_bpath.h
trunk/blender/source/blender/blenlib/BLI_cpu.h
trunk/blender/source/blender/blenlib/BLI_dlrbTree.h
trunk/blender/source/blender/blenlib/BLI_dynstr.h
trunk/blender/source/blender/blenlib/BLI_edgehash.h
trunk/blender/source/blender/blenlib/BLI_editVert.h
trunk/blender/source/blender/blenlib/BLI_fileops.h
trunk/blender/source/blender/blenlib/BLI_fnmatch.h
trunk/blender/source/blender/blenlib/BLI_ghash.h
trunk/blender/source/blender/blenlib/BLI_graph.h
trunk/blender/source/blender/blenlib/BLI_gsqueue.h
trunk/blender/source/blender/blenlib/BLI_heap.h
trunk/blender/source/blender/blenlib/BLI_jitter.h
trunk/blender/source/blender/blenlib/BLI_kdopbvh.h
trunk/blender/source/blender/blenlib/BLI_kdtree.h
trunk/blender/source/blender/blenlib/BLI_linklist.h
trunk/blender/source/blender/blenlib/BLI_listbase.h
trunk/blender/source/blender/blenlib/BLI_math.h
trunk/blender/source/blender/blenlib/BLI_math_base.h
trunk/blender/source/blender/blenlib/BLI_math_color.h
trunk/blender/source/blender/blenlib/BLI_math_geom.h
trunk/blender/source/blender/blenlib/BLI_math_inline.h
trunk/blender/source/blender/blenlib/BLI_math_matrix.h
trunk/blender/source/blender/blenlib/BLI_math_rotation.h
trunk/blender/source/blender/blenlib/BLI_math_vector.h
trunk/blender/source/blender/blenlib/BLI_memarena.h
trunk/blender/source/blender/blenlib/BLI_mempool.h
trunk/blender/source/blender/blenlib/BLI_noise.h
trunk/blender/source/blender/blenlib/BLI_path_util.h
trunk/blender/source/blender/blenlib/BLI_pbvh.h
trunk/blender/source/blender/blenlib/BLI_rand.h
trunk/blender/source/blender/blenlib/BLI_rect.h
trunk/blender/source/blender/blenlib/BLI_scanfill.h
trunk/blender/source/blender/blenlib/BLI_storage.h
trunk/blender/source/blender/blenlib/BLI_storage_types.h
trunk/blender/source/blender/blenlib/BLI_string.h
trunk/blender/source/blender/blenlib/BLI_threads.h
trunk/blender/source/blender/blenlib/BLI_utildefines.h
trunk/blender/source/blender/blenlib/BLI_uvproject.h
trunk/blender/source/blender/blenlib/BLI_vfontdata.h
trunk/blender/source/blender/blenlib/BLI_voxel.h
trunk/blender/source/blender/blenlib/BLI_winstuff.h
Modified: trunk/blender/doc/Doxyfile
===================================================================
--- trunk/blender/doc/Doxyfile 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/doc/Doxyfile 2011-02-18 13:58:08 UTC (rev 34966)
@@ -625,7 +625,8 @@
../intern/ghost \
../source/blender/blenloader \
../source/blender/readblenfile \
- ../source/blender/blenkernel
+ ../source/blender/blenkernel \
+ ../source/blender/blenlib
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Modified: trunk/blender/source/blender/blenlib/BLI_args.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_args.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_args.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,6 +1,4 @@
-/**
- * A general argument parsing module
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,11 @@
#ifndef BLI_ARGS_H
#define BLI_ARGS_H
+/** \file BLI_args.h
+ * \ingroup bli
+ * \brief A general argument parsing module.
+ */
+
struct bArgs;
typedef struct bArgs bArgs;
Modified: trunk/blender/source/blender/blenlib/BLI_blenlib.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_blenlib.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_blenlib.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -25,10 +25,14 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file BLI_blenlib.h
+ * \ingroup bli
*
- * @mainpage BLI - Blender LIbrary external interface
+ * \section aboutbli Blender LIbrary external interface
*
- * @section about About the BLI module
+ * \subsection about About the BLI module
*
* This is the external interface of the Blender Library. If you find
* a call to a BLI function that is not prototyped here, please add a
@@ -39,7 +43,7 @@
* allocation/deallocation. There is also a patch to make MS Windows
* behave more or less Posix-compliant.
*
- * @section issues Known issues with BLI
+ * \subsection issues Known issues with BLI
*
* - blenlib is written in C.
* - The posix-compliancy may move to a separate lib that deals with
@@ -51,13 +55,11 @@
* - vectorops.c is close to superfluous. It may disappear in the
* near future.
*
- * @section dependencies Dependencies
+ * \subsection dependencies Dependencies
*
- * - The blenlib uses type defines from makesdna/, and functions from
+ * - The blenlib uses type defines from \ref DNA, and functions from
* standard libraries.
- *
- * $Id$
-*/
+ */
#ifndef BLI_BLENLIB_H
#define BLI_BLENLIB_H
Modified: trunk/blender/source/blender/blenlib/BLI_boxpack2d.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_boxpack2d.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_boxpack2d.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,6 +1,4 @@
-/**
- *
- *
+/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -27,6 +25,13 @@
* ***** END GPL LICENSE BLOCK *****
*/
+#ifndef _BLI_BOXPACK2D_H_
+#define _BLI_BOXPACK2D_H_
+
+/** \file BLI_boxpack2d.h
+ * \ingroup bli
+ */
+
/* Box Packer */
typedef struct boxPack {
@@ -43,3 +48,5 @@
void boxPack2D(boxPack *boxarray, const int len, float *tot_width, float *tot_height);
+#endif
+
Modified: trunk/blender/source/blender/blenlib/BLI_bpath.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_bpath.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_bpath.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,4 +1,4 @@
-/**
+/*
*
* ***** BEGIN GPL LICENSE BLOCK *****
*
@@ -26,8 +26,11 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/* Based on ghash, difference is ghash is not a fixed size,
- * so for BPath we dont need to malloc */
+/** \file BLI_bpath.h
+ * \ingroup bli
+ * \attention Based on ghash, difference is ghash is not a fixed size,
+ * so for BPath we dont need to malloc
+ */
#ifndef BLI_BPATH_H
#define BLI_BPATH_H
Modified: trunk/blender/source/blender/blenlib/BLI_cpu.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_cpu.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_cpu.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,5 +1,4 @@
/*
- *
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -24,6 +23,10 @@
#ifndef BLI_CPU_H
#define BLI_CPU_H
+/** \file BLI_cpu.h
+ * \ingroup bli
+ */
+
int BLI_cpu_support_sse2(void);
#endif
Modified: trunk/blender/source/blender/blenlib/BLI_dlrbTree.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_dlrbTree.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_dlrbTree.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,11 @@
#ifndef BLI_DLRB_TREE_H
#define BLI_DLRB_TREE_H
+/** \file BLI_dlrbTree.h
+ * \ingroup bli
+ * \author Joshua Leung
+ */
+
/* Double-Linked Red-Black Tree Implementation:
*
* This is simply a Red-Black Tree implementation whose nodes can later
Modified: trunk/blender/source/blender/blenlib/BLI_dynstr.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_dynstr.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_dynstr.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,12 +1,4 @@
-/**
- * @file BLI_dynstr.h
- *
- * A dynamically sized string ADT.
- * This ADT is designed purely for dynamic string creation
- * through appending, not for general usage, the intent is
- * to build up dynamic strings using a DynStr object, then
- * convert it to a c-string and work with that.
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -38,6 +30,16 @@
#ifndef BLI_DYNSTR_H
#define BLI_DYNSTR_H
+/** \file BLI_dynstr.h
+ * \ingroup bli
+ * \brief A dynamically sized string ADT.
+ * \section aboutdynstr Dynamic String
+ * This ADT is designed purely for dynamic string creation
+ * through appending, not for general usage, the intent is
+ * to build up dynamic strings using a DynStr object, then
+ * convert it to a c-string and work with that.
+ */
+
#include <stdarg.h>
struct DynStr;
Modified: trunk/blender/source/blender/blenlib/BLI_edgehash.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_edgehash.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_edgehash.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,6 +1,4 @@
-/**
- * A general unordered 2-int pair hash table ADT
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,12 @@
#ifndef BLI_EDGEHASH_H
#define BLI_EDGEHASH_H
+/** \file BLI_storage.h
+ * \ingroup bli
+ * \author Daniel Dunbar
+ * \brief A general unordered 2-int pair hash table ADT.
+ */
+
struct EdgeHash;
struct EdgeHashIterator;
typedef struct EdgeHash EdgeHash;
Modified: trunk/blender/source/blender/blenlib/BLI_editVert.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_editVert.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_editVert.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,9 +1,4 @@
-/**
- * blenlib/BLI_editVert.h mar 2001 Nzc
- *
- * Some editing types needed in the lib (unfortunately) for
- * scanfill.c
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -35,6 +30,14 @@
#ifndef BLI_EDITVERT_H
#define BLI_EDITVERT_H
+/** \file BLI_editVert.h
+ * \ingroup bli
+ * \since March 2001
+ * \author nzc
+ * \brief Some editing types needed in the lib (unfortunately) for
+ * scanfill.c
+ */
+
#include "DNA_customdata_types.h"
#include "DNA_mesh_types.h"
Modified: trunk/blender/source/blender/blenlib/BLI_fileops.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_fileops.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_fileops.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,6 +1,4 @@
-/**
- * blenlib/BLI_listBase.h mar 2001 Nzc
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,8 +25,12 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
- *
- * More low-level fileops from Daniel Dunbar. Two functions were also
+ */
+
+/** \file BLI_fileops.h
+ * \ingroup bli
+ * \author Daniel Dunbar
+ * \brief More low-level fileops from Daniel Dunbar. Two functions were also
* defined in storage.c. These are the old fop_ prefixes. There is
* definitely some redundancy here!
* */
Modified: trunk/blender/source/blender/blenlib/BLI_fnmatch.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_fnmatch.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_fnmatch.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -18,9 +18,12 @@
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
#ifndef _FNMATCH_H
-
#define _FNMATCH_H 1
+/** \file BLI_fnmatch.h
+ * \ingroup bli
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
Modified: trunk/blender/source/blender/blenlib/BLI_ghash.h
===================================================================
--- trunk/blender/source/blender/blenlib/BLI_ghash.h 2011-02-18 13:57:54 UTC (rev 34965)
+++ trunk/blender/source/blender/blenlib/BLI_ghash.h 2011-02-18 13:58:08 UTC (rev 34966)
@@ -1,6 +1,4 @@
-/**
- * A general (pointer -> pointer) hash table ADT
- *
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,11 @@
#ifndef BLI_GHASH_H
#define BLI_GHASH_H
+/** \file BLI_ghash.h
+ * \ingroup bli
+ * \brief A general (pointer -> pointer) hash table ADT
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
Modified: trunk/blender/source/blender/blenlib/BLI_graph.h
===================================================================
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list