Skip to content
Snippets Groups Projects
Commit b97ad119 authored by Nathan Letwory's avatar Nathan Letwory
Browse files

doxygen: add blenlib under core as module.

parent 8856b598
No related branches found
No related tags found
No related merge requests found
Showing
with 130 additions and 63 deletions
......@@ -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
......
/**
* 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;
......
......@@ -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,12 +55,10 @@
* - 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
......
/**
*
*
/*
* ***** 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
/**
/*
*
* ***** 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
......
/*
*
* $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
......
/**
/*
* $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
......
/**
* @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;
......
/**
* 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;
......
/**
* 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"
......
/**
* 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!
* */
......
......@@ -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
......
/**
* 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
......
#ifndef BLI_GRAPH_H_
#define BLI_GRAPH_H_
/** \file BLI_graph.h
* \ingroup bli
*/
#include "DNA_listBase.h"
struct BGraph;
......
/*
* 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;
/**
......
/**
* 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;
......
/*
* 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);
......
/**
*
/*
* $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
......
/**
* 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;
......
/*
* 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);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment