Cleanup: remove redundant doxygen \file argument

Move \ingroup onto same line to be more compact and
make it clear the file is in the group.
This commit is contained in:
2019-02-06 15:42:22 +11:00
parent 1085c2cc44
commit eef4077f18
2945 changed files with 2947 additions and 5892 deletions

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines the '_bpy' module which is used by python's 'bpy' package
* to access C defined builtin functions.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines a 'PyStructSequence' accessed via 'bpy.app', mostly
* exposing static applications variables such as version and buildinfo

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_H__

View File

@@ -17,8 +17,7 @@
* All rights reserved.
*/
/** \file blender/python/intern/bpy_app_alembic.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -17,8 +17,7 @@
* All rights reserved.
*/
/** \file blender/python/intern/bpy_app_alembic.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_ALEMBIC_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_build_options.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_build_options.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_BUILD_OPTIONS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_ffmpeg.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_ffmpeg.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_FFMPEG_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_handlers.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines a 'PyStructSequence' accessed via 'bpy.app.handlers',
* which exposes various lists that the script author can add callback

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_handlers.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_HANDLERS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_icons.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* Runtime defined icons.
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_icons.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_ICONS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_ocio.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_ocio.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_OCIO_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_oiio.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_oiio.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_OIIO_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_opensubdiv.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_opensubdiv.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_OPENSUBDIV_H__

View File

@@ -17,8 +17,7 @@
* All rights reserved.
*/
/** \file blender/python/intern/bpy_app_openvdb.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -17,8 +17,7 @@
* All rights reserved.
*/
/** \file blender/python/intern/bpy_app_openvdb.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_OPENVDB_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_sdl.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_sdl.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_SDL_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_timers.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include <Python.h>

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_timers.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_TIMERS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_translations.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines a singleton py object accessed via 'bpy.app.translations',
* which exposes various data and functions useful in i18n work.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_app_translations.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_APP_TRANSLATIONS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_capi_utils.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file contains Blender/Python utility functions to help implementing API's.
* This is not related to a particular module.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_capi_utils.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_CAPI_UTILS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_driver.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines the 'BPY_driver_exec' to execute python driver expressions,
* called by the animation system, there are also some utility functions

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_driver.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_DRIVER_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_gizmo_wrap.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file is so Python can define widget-group's that C can call into.
* The generic callback functions for Python widget-group are defines in

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_gizmo_wrap.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_GIZMO_WRAP_H__

View File

@@ -16,8 +16,7 @@
* Chris Keith, Chris Want, Ken Hughes, Campbell Barton
*/
/** \file blender/python/intern/bpy_interface.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file deals with embedding the python interpreter within blender,
* starting and stopping python and exposing blender/python modules so they can

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_interface_atexit.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file inserts an exit callback into pythons 'atexit' module.
* Without this sys.exit() can crash because blender is not properly closing

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_intern_string.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* Store python versions of strings frequently used for python lookups
* to avoid converting, creating the hash and freeing every time as

View File

@@ -17,8 +17,7 @@
#ifndef __BPY_INTERN_STRING_H__
#define __BPY_INTERN_STRING_H__
/** \file blender/python/intern/bpy_intern_string.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
void bpy_intern_string_init(void);

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_library.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_LIBRARY_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_library_load.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file exposed blend file library appending/linking to python, typically
* this would be done via RNA api but in this case a hand written python api

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_library_write.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* Python API for writing a set of data-blocks into a file.
* Useful for writing out asset-libraries, defines: `bpy.data.libraries.write(...)`.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_msgbus.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
* This file defines '_bpy_msgbus' module, exposed as 'bpy.msgbus'.
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_msgbus.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_MSGBUS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_operator.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines '_bpy.ops', an internal python module which gives python
* the ability to inspect and call both C and Python defined operators.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_operator.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_OPERATOR_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_operator_wrap.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file is so python can define operators that C can call into.
* The generic callback functions for python operators are defines in

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_operator_wrap.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_OPERATOR_WRAP_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_path.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines '_bpy_path' module, Some 'C' functionality used by 'bpy.path'
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_path.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_props.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines 'bpy.props' module used so scripts can define their own
* rna properties for use with python operators or adding new properties to

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_props.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file is the main interface between python and blenders data api (RNA),
* exposing RNA to python so blender data can be accessed in a python like way.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_RNA_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_anim.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines the animation related methods used in bpy_rna.c
*/

View File

@@ -17,8 +17,7 @@
#ifndef __BPY_RNA_ANIM_H__
#define __BPY_RNA_ANIM_H__
/** \file blender/python/intern/bpy_rna_anim.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
extern char pyrna_struct_keyframe_insert_doc[];

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_array.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file deals with array access for 'BPy_PropertyArrayRNA' from bpy_rna.c
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_callback.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file currently exposes callbacks for interface regions but may be
* extended later.

View File

@@ -17,8 +17,7 @@
#ifndef __BPY_RNA_CALLBACK_H__
#define __BPY_RNA_CALLBACK_H__
/** \file blender/python/intern/bpy_rna_callback.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
struct BPy_StructRNA;

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_driver.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines utility functions that use the RNA API, from PyDrivers.
*/

View File

@@ -17,8 +17,7 @@
#ifndef __BPY_RNA_DRIVER_H__
#define __BPY_RNA_DRIVER_H__
/** \file blender/python/intern/bpy_rna_driver.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
struct ChannelDriver;

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_gizmo.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* .
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_gizmo.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_RNA_GIZMO_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_id_collection.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file adds some helpers related to ID/Main handling, that cannot fit well in RNA itself.
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_rna_id_collection.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_RNA_ID_COLLECTION_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_traceback.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file contains utility functions for getting data from a python stack
* trace.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_traceback.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_utils_previews.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines a singleton py object accessed via 'bpy.utils.previews',
* which exposes low-level API for custom previews/icons.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_utils_previews.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_UTILS_PREVIEWS_H__

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_utils_units.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*
* This file defines a singleton py object accessed via 'bpy.utils.units',
* which exposes various data and functions useful in units handling.

View File

@@ -14,8 +14,7 @@
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/** \file blender/python/intern/bpy_utils_units.h
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#ifndef __BPY_UTILS_UNITS_H__

View File

@@ -17,8 +17,7 @@
* All rights reserved.
*/
/** \file blender/python/intern/stubs.c
* \ingroup pythonintern
/** \file \ingroup pythonintern
*/
#include "BLI_utildefines.h"