doxygen: add blenlib under core as module.

This commit is contained in:
Nathan Letwory
2011-02-18 13:58:08 +00:00
parent 8856b598fd
commit b97ad119b9
46 changed files with 288 additions and 140 deletions

View File

@@ -625,7 +625,8 @@ INPUT = doxygen.main \
../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

View File

@@ -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;

View File

@@ -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

View File

@@ -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 @@ typedef struct boxPack {
void boxPack2D(boxPack *boxarray, const int len, float *tot_width, float *tot_height);
#endif

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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;

View File

@@ -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;

View File

@@ -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"

View File

@@ -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!
* */

View File

@@ -18,9 +18,12 @@ along with this program; if not, write to the Free Software Foundation,
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

View File

@@ -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

View File

@@ -1,6 +1,10 @@
#ifndef BLI_GRAPH_H_
#define BLI_GRAPH_H_
/** \file BLI_graph.h
* \ingroup bli
*/
#include "DNA_listBase.h"
struct BGraph;

View File

@@ -1,7 +1,4 @@
/*
* A generic structure queue (a queue for fixed length
* (generally small) structures.
*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +30,12 @@
#ifndef BLI_GSQUEUE_H
#define BLI_GSQUEUE_H
/** \file BLI_gsqueue.h
* \ingroup bli
* \brief A generic structure queue (a queue for fixed length
* (generally small) structures.
*/
typedef struct _GSQueue GSQueue;
/**

View File

@@ -1,6 +1,4 @@
/**
* A heap / priority queue ADT
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,11 @@
#ifndef BLI_HEAP_H
#define BLI_HEAP_H
/** \file BLI_heap.h
* \ingroup bli
* \brief A heap / priority queue ADT
*/
struct Heap;
struct HeapNode;
typedef struct Heap Heap;

View File

@@ -1,6 +1,4 @@
/*
* jitter.h
*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,10 @@
#ifndef BLI_JITTER_H
#define BLI_JITTER_H
/** \file BLI_jitter.h
* \ingroup bli
*/
void BLI_initjit(float *jitarr, int num);
void BLI_jitterate1(float *jit1, float *jit2, int num, float rad1);
void BLI_jitterate2(float *jit1, float *jit2, int num, float rad2);

View File

@@ -1,5 +1,4 @@
/**
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +31,12 @@
#ifndef BLI_KDOPBVH_H
#define BLI_KDOPBVH_H
/** \file BLI_kdopbvh.h
* \ingroup bli
* \author Daniel Genrich
* \author Andre Pinto
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,6 +1,4 @@
/**
* A kd-tree for nearest neighbour search.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +31,13 @@
#ifndef BLI_KDTREE_H
#define BLI_KDTREE_H
/** \file BLI_kdtree.h
* \ingroup bli
* \brief A kd-tree for nearest neighbour search.
* \author Janne Karhu
* \author Brecht van Lommel
*/
struct KDTree;
typedef struct KDTree KDTree;

View File

@@ -1,7 +1,4 @@
/*
* Routines for working with singly linked lists
* of 'links' - pointers to other data.
*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +30,13 @@
#ifndef BLI_LINKLIST_H
#define BLI_LINKLIST_H
/** \file BLI_linklist.h
* \ingroup bli
* \brief Routines for working with singly linked lists
* of 'links' - pointers to other data.
*
*/
struct MemArena;
typedef void (*LinkNodeFreeFP)(void *link);

View File

@@ -25,13 +25,15 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*
* $Id$
*/
#ifndef BLI_LISTBASE_H
#define BLI_LISTBASE_H
/** \file BLI_listbase.h
* \ingroup bli
*/
#include "DNA_listBase.h"
//struct ListBase;
//struct LinkData;

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,29 +28,30 @@
#ifndef BLI_MATH_H
#define BLI_MATH_H
/* Abbreviations:
/** \file BLI_math.h
* \ingroup bli
* \section mathabbrev Abbreviations
*
* fl = float
* db = double
* v2 = vec2 = vector 2
* v3 = vec3 = vector 3
* v4 = vec4 = vector 4
* qt = quat = quaternion
* dq = dquat = dual quaternion
* m2 = mat2 = matrix 2x2
* m3 = mat3 = matrix 3x3
* m4 = mat4 = matrix 4x4
* eul = euler rotation
* eulO = euler with order
* - fl = float
* - db = double
* - v2 = vec2 = vector 2
* - v3 = vec3 = vector 3
* - v4 = vec4 = vector 4
* - qt = quat = quaternion
* - dq = dquat = dual quaternion
* - m2 = mat2 = matrix 2x2
* - m3 = mat3 = matrix 3x3
* - m4 = mat4 = matrix 4x4
* - eul = euler rotation
* - eulO = euler with order
*
* Variable Names:
*
* f = single value
* a, b, c = vectors
* r = result vector
* A, B, C = matrices
* R = result matrix
* \section mathvarnames Variable Names
*
* - f = single value
* - a, b, c = vectors
* - r = result vector
* - A, B, C = matrices
* - R = result matrix
*/
#include "BLI_math_base.h"

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_BASE_H
#define BLI_MATH_BASE_H
/** \file BLI_math_base.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_COLOR_H
#define BLI_MATH_COLOR_H
/** \file BLI_math_color.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_GEOM_H
#define BLI_MATH_GEOM_H
/** \file BLI_math_geom.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_INLINE_H
#define BLI_MATH_INLINE_H
/** \file BLI_math_inline.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_MATRIX_H
#define BLI_MATH_MATRIX_H
/** \file BLI_math_matrix.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_ROTATION_H
#define BLI_MATH_ROTATION_H
/** \file BLI_math_rotation.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -28,6 +28,10 @@
#ifndef BLI_MATH_VECTOR_H
#define BLI_MATH_VECTOR_H
/** \file BLI_math_vector.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,6 +1,4 @@
/*
* Memory arena ADT
*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,11 +25,15 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*
*/
/** \file BLI_memarena.h
* \ingroup bli
* \brief Memory arena ADT.
* \section aboutmemarena Memory Arena
* Memory arena's are commonly used when the program
* needs to quickly allocate lots of little bits of
* data, which are all freed at the same moment.
*
*/
#ifndef BLI_MEMARENA_H

View File

@@ -1,7 +1,5 @@
/**
* Simple fast memory allocator
*
*
/*
* $Id$
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -31,6 +29,12 @@
#ifndef BLI_MEMPOOL_H
#define BLI_MEMPOOL_H
/** \file BLI_storage.h
* \ingroup bli
* \author Geoffrey Bantle
* \brief Simple fast memory allocator.
*/
struct BLI_mempool;
struct BLI_mempool *BLI_mempool_create(int esize, int tote, int pchunk, int use_sysmalloc);

View File

@@ -31,6 +31,10 @@
#ifndef BLI_NOISE_H
#define BLI_NOISE_H
/** \file BLI_noise.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,8 +1,4 @@
/**
* blenlib/BLI_storage_types.h
*
* Some types for dealing with directories
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +29,10 @@
#ifndef BLI_PATH_UTIL_H
#define BLI_PATH_UTIL_H
/** \file BLI_path_util.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -1,6 +1,4 @@
/**
* A BVH for high poly meshes.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,6 +23,11 @@
#ifndef BLI_PBVH_H
#define BLI_PBVH_H
/** \file BLI_pbvh.h
* \ingroup bli
* \brief A BVH for high poly meshes.
*/
struct MFace;
struct MVert;
struct DMGridAdjacency;

View File

@@ -1,7 +1,4 @@
/**
* @file BLI_rand.h
*
* Random number functions.
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,10 +30,15 @@
#ifndef BLI_RAND_H
#define BLI_RAND_H
/* RNG is just an abstract random number generator
* type that avoids using globals, otherwise identical
* to BLI_rand functions below.
*/
/** \file BLI_rand.h
* \ingroup bli
* \brief Random number functions.
*/
/** RNG is just an abstract random number generator
* type that avoids using globals, otherwise identical
* to BLI_rand functions below.
*/
struct RNG;
typedef struct RNG RNG;

View File

@@ -31,6 +31,10 @@
#ifndef BLI_RECT_H
#define BLI_RECT_H
/** \file BLI_rect.h
* \ingroup bli
*/
struct rctf;
struct rcti;

View File

@@ -1,8 +1,4 @@
/**
* blenlib/BLI_scanfill.h mar 2001 Nzc
*
* Filling meshes.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -34,6 +30,13 @@
#ifndef BLI_SCANFILL_H
#define BLI_SCANFILL_H
/** \file BLI_storage.h
* \ingroup bli
* \since March 2001
* \author nzc
* \brief Filling meshes.
*/
/**
* @attention Defined in scanfill.c
*/

View File

@@ -29,6 +29,10 @@
#ifndef BLI_STORAGE_H
#define BLI_STORAGE_H
/** \file BLI_storage.h
* \ingroup bli
*/
#ifdef WIN32
/* for size_t, only needed on win32 for some reason */
#include <stddef.h>

View File

@@ -1,8 +1,4 @@
/**
* blenlib/BLI_storage_types.h
*
* Some types for dealing with directories
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -33,6 +29,11 @@
#ifndef BLI_STORAGE_TYPES_H
#define BLI_STORAGE_TYPES_H
/** \file BLI_storage_types.h
* \ingroup bli
* \brief Some types for dealing with directories.
*/
#include <sys/stat.h>
#if defined(WIN32) && !defined(FREE_WINDOWS)

View File

@@ -32,6 +32,10 @@
#ifndef BLI_STRING_H
#define BLI_STRING_H
/** \file BLI_string.h
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif

View File

@@ -31,6 +31,10 @@
#ifndef BLI_THREADS_H
#define BLI_THREADS_H
/** \file BLI_threads.h
* \ingroup bli
*/
#include <pthread.h>
/* for tables, button in UI, etc */

View File

@@ -30,6 +30,10 @@
#ifndef BLI_UTILDEFINES_H
#define BLI_UTILDEFINES_H
/** \file BLI_utildefines.h
* \ingroup bli
*/
#ifndef FALSE
#define FALSE 0
#endif

View File

@@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -22,6 +22,10 @@
#ifndef BKE_UVPROJECT_H
#define BKE_UVPROJECT_H
/** \file BLI_uvproject.h
* \ingroup bli
*/
struct UvCameraInfo;
struct Object;

View File

@@ -1,9 +1,4 @@
/**
* @file BLI_vfontdata.h
*
* A structure to represent vector fonts,
* and to load them from PostScript fonts.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -35,6 +30,12 @@
#ifndef BLI_VFONTDATA_H
#define BLI_VFONTDATA_H
/** \file BLI_vfontdata.h
* \ingroup bli
* \brief A structure to represent vector fonts,
* and to load them from PostScript fonts.
*/
#include "DNA_listBase.h"
struct PackedFile;

View File

@@ -1,5 +1,4 @@
/**
*
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@@ -29,7 +28,11 @@
#ifndef BLI_VOXEL_H
#define BLI_VOXEL_H
/* find the index number of a voxel, given x/y/z integer coords and resolution vector */
/** \file BLI_voxel.h
* \ingroup bli
*/
/** find the index number of a voxel, given x/y/z integer coords and resolution vector */
#define V_I(x, y, z, res) ( (z)*(res)[1]*(res)[0] + (y)*(res)[0] + (x) )
/* all input coordinates must be in bounding box 0.0 - 1.0 */

View File

@@ -1,6 +1,4 @@
/**
* Compatibility-like things for windows.
*
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -32,6 +30,11 @@
#ifndef __WINSTUFF_H__
#define __WINSTUFF_H__
/** \file BLI_winstuff.h
* \ingroup bli
* \brief Compatibility-like things for windows.
*/
#ifdef _WIN32
#ifndef FREE_WINDOWS