forked from bartvdbraak/blender
code cleanup: headers - doxy comments.
This commit is contained in:
parent
30695da261
commit
8beb565c59
@ -28,7 +28,9 @@
|
||||
#ifndef __BKE_DERIVEDMESH_H__
|
||||
#define __BKE_DERIVEDMESH_H__
|
||||
|
||||
/**
|
||||
/** \file BKE_DerivedMesh.h
|
||||
* \ingroup bke
|
||||
*
|
||||
* Basic design of the DerivedMesh system:
|
||||
*
|
||||
* DerivedMesh is a common set of interfaces for mesh systems.
|
||||
|
@ -22,6 +22,10 @@
|
||||
#ifndef __BKE_ADDON_H__
|
||||
#define __BKE_ADDON_H__
|
||||
|
||||
/** \file BKE_addon.h
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include "RNA_types.h"
|
||||
|
||||
typedef struct bAddonPrefType {
|
||||
|
@ -28,6 +28,10 @@
|
||||
#ifndef __BKE_CCG_H__
|
||||
#define __BKE_CCG_H__
|
||||
|
||||
/** \file BKE_ccg.h
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
/* defines BLI_INLINE */
|
||||
#include "BLI_utildefines.h"
|
||||
|
||||
|
@ -23,6 +23,10 @@
|
||||
#ifndef __BKE_EDITMESH_H__
|
||||
#define __BKE_EDITMESH_H__
|
||||
|
||||
/** \file BKE_editmesh.h
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include "BKE_customdata.h"
|
||||
#include "bmesh.h"
|
||||
|
||||
|
@ -28,6 +28,10 @@
|
||||
#ifndef __BKE_MASK_H__
|
||||
#define __BKE_MASK_H__
|
||||
|
||||
/** \file BKE_mask.h
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
struct ImageUser;
|
||||
struct Image;
|
||||
struct ListBase;
|
||||
|
@ -28,6 +28,10 @@
|
||||
#ifndef __BKE_NAVMESH_CONVERSION_H__
|
||||
#define __BKE_NAVMESH_CONVERSION_H__
|
||||
|
||||
/** \file BKE_navmesh_conversion.h
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
struct DerivedMesh;
|
||||
|
||||
/* navmesh_conversion.c */
|
||||
|
@ -23,6 +23,10 @@
|
||||
#ifndef __BKE_OCEAN_H__
|
||||
#define __BKE_OCEAN_H__
|
||||
|
||||
/** \file BLI_ocean.h
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
@ -20,6 +20,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenkernel/intern/addon.c
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
|
@ -20,6 +20,9 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenkernel/intern/dynamicpaint.c
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
|
@ -25,6 +25,9 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenkernel/intern/ocean.c
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include <math.h>
|
||||
#include <stdlib.h>
|
||||
|
@ -18,6 +18,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenkernel/intern/pbvh_bmesh.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
#include "BLI_utildefines.h"
|
||||
|
@ -21,6 +21,10 @@
|
||||
#ifndef __PBVH_INTERN_H__
|
||||
#define __PBVH_INTERN_H__
|
||||
|
||||
/** \file blender/blenkernel/intern/pbvh_intern.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
/* Axis-aligned bounding box */
|
||||
typedef struct {
|
||||
float bmin[3], bmax[3];
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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 {
|
||||
|
@ -18,7 +18,7 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenlib/BLI_callbacks.h
|
||||
/** \file BLI_callbacks.h
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
|
@ -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);
|
||||
|
||||
|
@ -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.
|
||||
|
@ -18,6 +18,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenlib/intern/buffer.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
#include "BLI_buffer.h"
|
||||
|
@ -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"
|
||||
|
@ -18,6 +18,11 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenlib/intern/convexhull2d.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
|
@ -26,6 +26,10 @@
|
||||
*
|
||||
*/
|
||||
|
||||
/** \file blender/blenlib/intern/math_interp.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
#include <math.h>
|
||||
|
||||
#include "BLI_math.h"
|
||||
|
@ -25,6 +25,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenlib/intern/smallhash.c
|
||||
* \ingroup bli
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
@ -18,6 +18,21 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/bmesh/intern/bmesh_log.c
|
||||
* \ingroup bmesh
|
||||
*
|
||||
* The BMLog is an interface for storing undo/redo steps as a BMesh is
|
||||
* modified. It only stores changes to the BMesh, not full copies.
|
||||
*
|
||||
* Currently it supports the following types of changes:
|
||||
*
|
||||
* - Adding and removing vertices
|
||||
* - Adding and removing faces
|
||||
* - Moving vertices
|
||||
* - Setting vertex paint-mask values
|
||||
* - Setting vertex hflags
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
#include "BLI_utildefines.h"
|
||||
|
@ -21,16 +21,8 @@
|
||||
#ifndef __BMESH_LOG_H__
|
||||
#define __BMESH_LOG_H__
|
||||
|
||||
/* The BMLog is an interface for storing undo/redo steps as a BMesh is
|
||||
* modified. It only stores changes to the BMesh, not full copies.
|
||||
*
|
||||
* Currently it supports the following types of changes:
|
||||
*
|
||||
* - Adding and removing vertices
|
||||
* - Adding and removing faces
|
||||
* - Moving vertices
|
||||
* - Setting vertex paint-mask values
|
||||
* - Setting vertex hflags
|
||||
/** \file blender/bmesh/intern/bmesh_log.h
|
||||
* \ingroup bmesh
|
||||
*/
|
||||
|
||||
struct BMFace;
|
||||
|
@ -25,6 +25,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/datatoc/datatoc.c
|
||||
* \ingroup datatoc
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
|
@ -26,6 +26,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/editors/mesh/mesh_navmesh.c
|
||||
* \ingroup edmesh
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
#include "DNA_scene_types.h"
|
||||
|
@ -18,6 +18,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/editors/physics/dynamicpaint_ops.c
|
||||
* \ingroup edphys
|
||||
*/
|
||||
|
||||
#include <math.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
|
@ -1,23 +1,22 @@
|
||||
|
||||
//
|
||||
// Copyright (C) : Please refer to the COPYRIGHT file distributed
|
||||
// with this source distribution.
|
||||
//
|
||||
// This program is free software; you can redistribute it and/or
|
||||
// modify it under the terms of the GNU General Public License
|
||||
// as published by the Free Software Foundation; either version 2
|
||||
// of the License, or (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
/*
|
||||
* ***** BEGIN GPL LICENSE BLOCK *****
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
*
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
# include "TextStrokeRenderer.h"
|
||||
# include "Canvas.h"
|
||||
|
@ -1,3 +1,27 @@
|
||||
/*
|
||||
* ***** BEGIN GPL LICENSE BLOCK *****
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
*
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/freestyle/intern/stroke/TextStrokeRenderer.h
|
||||
* \ingroup freestyle
|
||||
*/
|
||||
|
||||
//
|
||||
// Filename : TextStrokeRenderer.h
|
||||
// Author(s) : Stephane Grabli
|
||||
@ -11,29 +35,8 @@
|
||||
//
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
//
|
||||
// Copyright (C) : Please refer to the COPYRIGHT file distributed
|
||||
// with this source distribution.
|
||||
//
|
||||
// This program is free software; you can redistribute it and/or
|
||||
// modify it under the terms of the GNU General Public License
|
||||
// as published by the Free Software Foundation; either version 2
|
||||
// of the License, or (at your option) any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// 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.
|
||||
//
|
||||
///////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifndef TEXTSTROKERENDERER_H
|
||||
# define TEXTSTROKERENDERER_H
|
||||
#ifndef TEXTSTROKERENDERER_H
|
||||
#define TEXTSTROKERENDERER_H
|
||||
|
||||
# include "StrokeRenderer.h"
|
||||
# include "../system/FreestyleConfig.h"
|
||||
|
@ -31,6 +31,10 @@
|
||||
#ifndef __IMB_COLORMANAGEMENT_H__
|
||||
#define __IMB_COLORMANAGEMENT_H__
|
||||
|
||||
/** \file blender/imbuf/IMB_colormanagement.h
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#include "BLI_sys_types.h"
|
||||
|
||||
#define BCM_CONFIG_FILE "config.ocio"
|
||||
|
@ -31,6 +31,10 @@
|
||||
#ifndef __IMB_COLORMANAGEMENT_INTERN_H__
|
||||
#define __IMB_COLORMANAGEMENT_INTERN_H__
|
||||
|
||||
/** \file IMB_colormanagement_intern.h
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#include "DNA_listBase.h"
|
||||
#include "BLI_sys_types.h"
|
||||
|
||||
|
@ -25,6 +25,10 @@
|
||||
#ifndef __IMB_INDEXER_H__
|
||||
#define __IMB_INDEXER_H__
|
||||
|
||||
/** \file IMB_indexer.h
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#ifdef WIN32
|
||||
# include <io.h>
|
||||
#endif
|
||||
|
@ -28,6 +28,10 @@
|
||||
*
|
||||
*/
|
||||
|
||||
/** \file blender/imbuf/intern/colormanagement.c
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#include "IMB_colormanagement.h"
|
||||
#include "IMB_colormanagement_intern.h"
|
||||
|
||||
|
@ -22,6 +22,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/imbuf/intern/indexer.c
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#include <stdlib.h>
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
@ -22,6 +22,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/imbuf/intern/indexer_dv.c
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
#include "MEM_guardedalloc.h"
|
||||
|
||||
#include "BLI_utildefines.h"
|
||||
|
@ -28,6 +28,10 @@
|
||||
#ifndef __DNA_FREESTYLE_TYPES_H__
|
||||
#define __DNA_FREESTYLE_TYPES_H__
|
||||
|
||||
/** \file DNA_freestyle_types.h
|
||||
* \ingroup DNA
|
||||
*/
|
||||
|
||||
#include "DNA_listBase.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
@ -28,6 +28,10 @@
|
||||
#ifndef __DNA_LINESTYLE_TYPES_H__
|
||||
#define __DNA_LINESTYLE_TYPES_H__
|
||||
|
||||
/** \file DNA_linestyle_types.h
|
||||
* \ingroup DNA
|
||||
*/
|
||||
|
||||
#include "DNA_listBase.h"
|
||||
#include "DNA_ID.h"
|
||||
|
||||
|
@ -20,6 +20,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/modifiers/intern/MOD_meshcache_util.c
|
||||
* \ingroup modifiers
|
||||
*/
|
||||
|
||||
#include "BLI_utildefines.h"
|
||||
#include "BLI_math.h"
|
||||
|
||||
|
@ -26,6 +26,10 @@
|
||||
#ifndef __TEXTURE_OCEAN_H__
|
||||
#define __TEXTURE_OCEAN_H__
|
||||
|
||||
/** \file blender/render/intern/include/texture_ocean.h
|
||||
* \ingroup render
|
||||
*/
|
||||
|
||||
int ocean_texture(struct Tex *tex, const float texvec[2], struct TexResult *texres);
|
||||
|
||||
#endif /* __TEXTURE_OCEAN_H__ */
|
||||
|
@ -23,6 +23,10 @@
|
||||
* ***** END GPL LICENSE BLOCK *****
|
||||
*/
|
||||
|
||||
/** \file blender/blenkernel/intern/texture_ocean.c
|
||||
* \ingroup bke
|
||||
*/
|
||||
|
||||
#include <stddef.h>
|
||||
|
||||
#include "BLI_math.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) 2001-2002 by NaN Holding BV.
|
||||
* All rights reserved.
|
||||
|
Loading…
Reference in New Issue
Block a user