diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
commit | 7bbf4b78313df9f6d2c760b527eb36a5d0418b82 (patch) | |
tree | ace55a086362cf5b35174d55442322a793dd32c1 /source/blender/blenloader | |
parent | c8636ca3dd8bde1cc548ef21fb7a1fd304799164 (diff) |
style cleanup
- spelling - turns out we had tessellation spelt wrong all over.
- use \directive for doxy (not @directive)
- remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.
Diffstat (limited to 'source/blender/blenloader')
-rw-r--r-- | source/blender/blenloader/BLO_readfile.h | 82 | ||||
-rw-r--r-- | source/blender/blenloader/intern/readfile.c | 16 | ||||
-rw-r--r-- | source/blender/blenloader/intern/writefile.c | 20 |
3 files changed, 59 insertions, 59 deletions
diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h index 52d06c36bdf..ffac9a2a88f 100644 --- a/source/blender/blenloader/BLO_readfile.h +++ b/source/blender/blenloader/BLO_readfile.h @@ -78,10 +78,10 @@ typedef struct BlendFileData { * returns NULL and sets a report in the list if * it cannot open the file. * - * @param filepath The path of the file to open. - * @param reports If the return value is NULL, errors + * \param filepath The path of the file to open. + * \param reports If the return value is NULL, errors * indicating the cause of the failure. - * @return The data of the file. + * \return The data of the file. */ BlendFileData* BLO_read_from_file(const char *filepath, struct ReportList *reports); @@ -90,11 +90,11 @@ BlendFileData* BLO_read_from_file(const char *filepath, struct ReportList *repor * returns NULL and sets a report in the list if * it cannot open the file. * - * @param mem The file data. - * @param memsize The length of @a mem. - * @param reports If the return value is NULL, errors + * \param mem The file data. + * \param memsize The length of \a mem. + * \param reports If the return value is NULL, errors * indicating the cause of the failure. - * @return The data of the file. + * \return The data of the file. */ BlendFileData* BLO_read_from_memory(void *mem, int memsize, struct ReportList *reports); @@ -109,7 +109,7 @@ BlendFileData *BLO_read_from_memfile(struct Main *oldmain, const char *filename, * data associated with it (the userdef data, and * the main libblock data). * - * @param bfd The structure to free. + * \param bfd The structure to free. */ void BLO_blendfiledata_free( @@ -118,9 +118,9 @@ BLO_blendfiledata_free( /** * Open a blendhandle from a file path. * - * @param file The file path to open. - * @param reports Report errors in opening the file (can be NULL). - * @return A handle on success, or NULL on failure. + * \param file The file path to open. + * \param reports Report errors in opening the file (can be NULL). + * \return A handle on success, or NULL on failure. */ BlendHandle* BLO_blendhandle_from_file( @@ -130,9 +130,9 @@ BLO_blendhandle_from_file( /** * Open a blendhandle from memory. * - * @param mem The data to load from. - * @param memsize The size of the data. - * @return A handle on success, or NULL on failure. + * \param mem The data to load from. + * \param memsize The size of the data. + * \return A handle on success, or NULL on failure. */ BlendHandle* @@ -145,10 +145,10 @@ BLO_blendhandle_from_memory( * of a certain type (ie. All the scene names in * a file). * - * @param bh The blendhandle to access. - * @param ofblocktype The type of names to get. - * @param tot_names The length of the returned list. - * @return A BLI_linklist of strings. The string links + * \param bh The blendhandle to access. + * \param ofblocktype The type of names to get. + * \param tot_names The length of the returned list. + * \return A BLI_linklist of strings. The string links * should be freed with malloc. */ struct LinkNode* @@ -162,10 +162,10 @@ BLO_blendhandle_get_datablock_names( * of a certain type (ie. All the scene names in * a file). * - * @param bh The blendhandle to access. - * @param ofblocktype The type of names to get. - * @param tot_prev The length of the returned list. - * @return A BLI_linklist of PreviewImage. The PreviewImage links + * \param bh The blendhandle to access. + * \param ofblocktype The type of names to get. + * \param tot_prev The length of the returned list. + * \return A BLI_linklist of PreviewImage. The PreviewImage links * should be freed with malloc. */ struct LinkNode* @@ -179,8 +179,8 @@ BLO_blendhandle_get_previews( * file. (ie. file contains Scene, Mesh, and Lamp * datablocks). * - * @param bh The blendhandle to access. - * @return A BLI_linklist of strings. The string links + * \param bh The blendhandle to access. + * \return A BLI_linklist of strings. The string links * should be freed with malloc. */ struct LinkNode* @@ -191,7 +191,7 @@ BLO_blendhandle_get_linkable_groups( * Close and free a blendhandle. The handle * becomes invalid after this call. * - * @param bh The handle to close. + * \param bh The handle to close. */ void BLO_blendhandle_close( @@ -212,10 +212,10 @@ int BLO_is_a_library(const char *path, char *dir, char *group); /** * Initialize the BlendHandle for appending or linking library data. * - * @param mainvar The current main database eg G.main or CTX_data_main(C). - * @param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory. - * @param filepath Used for relative linking, copied to the lib->name - * @return the library Main, to be passed to BLO_library_append_named_part as mainl. + * \param mainvar The current main database eg G.main or CTX_data_main(C). + * \param bh A blender file handle as returned by BLO_blendhandle_from_file or BLO_blendhandle_from_memory. + * \param filepath Used for relative linking, copied to the lib->name + * \return the library Main, to be passed to BLO_library_append_named_part as mainl. */ struct Main* BLO_library_append_begin(struct Main *mainvar, BlendHandle** bh, const char *filepath); @@ -223,11 +223,11 @@ struct Main* BLO_library_append_begin(struct Main *mainvar, BlendHandle** bh, co /** * Link/Append a named datablock from an external blend file. * - * @param mainl The main database to link from (not the active one). - * @param bh The blender file handle. - * @param idname The name of the datablock (without the 2 char ID prefix) - * @param idcode The kind of datablock to link. - * @return the appended ID when found. + * \param mainl The main database to link from (not the active one). + * \param bh The blender file handle. + * \param idname The name of the datablock (without the 2 char ID prefix) + * \param idcode The kind of datablock to link. + * \return the appended ID when found. */ struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle** bh, const char *idname, const int idcode); @@ -235,13 +235,13 @@ struct ID *BLO_library_append_named_part(struct Main *mainl, BlendHandle** bh, c * Link/Append a named datablock from an external blend file. * optionally instance the object in the scene when the flags are set. * - * @param C The context, when NULL instancing object in the scene isnt done. - * @param mainl The main database to link from (not the active one). - * @param bh The blender file handle. - * @param idname The name of the datablock (without the 2 char ID prefix) - * @param idcode The kind of datablock to link. - * @param flag Options for linking, used for instancing. - * @return the appended ID when found. + * \param C The context, when NULL instancing object in the scene isnt done. + * \param mainl The main database to link from (not the active one). + * \param bh The blender file handle. + * \param idname The name of the datablock (without the 2 char ID prefix) + * \param idcode The kind of datablock to link. + * \param flag Options for linking, used for instancing. + * \return the appended ID when found. */ struct ID *BLO_library_append_named_part_ex(const struct bContext *C, struct Main *mainl, BlendHandle** bh, const char *idname, const int idcode, const short flag); diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index 36653647fa9..fafddaa544f 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -6857,7 +6857,7 @@ static void area_add_header_region(ScrArea *sa, ListBase *lb) else ar->alignment= RGN_ALIGN_TOP; - /* initialise view2d data for header region, to allow panning */ + /* initialize view2d data for header region, to allow panning */ /* is copy from ui_view2d.c */ ar->v2d.keepzoom = (V2D_LOCKZOOM_X|V2D_LOCKZOOM_Y|V2D_LIMITZOOM|V2D_KEEPASPECT); ar->v2d.keepofs = V2D_LOCKOFS_Y; @@ -9868,7 +9868,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* correctly initialise constinv matrix */ + /* correctly initialize constinv matrix */ unit_m4(ob->constinv); if (ob->type == OB_ARMATURE) { @@ -9898,7 +9898,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* correctly initialise constinv matrix */ + /* correctly initialize constinv matrix */ unit_m4(pchan->constinv); } } @@ -11510,7 +11510,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) { Object *ob; - /* properly initialise hair clothsim data on old files */ + /* properly initialize hair clothsim data on old files */ for(ob = main->object.first; ob; ob = ob->id.next) { ModifierData *md; for(md= ob->modifiers.first; md; md= md->next) { @@ -11619,7 +11619,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) /* anim viz changes */ for (ob= main->object.first; ob; ob= ob->id.next) { - /* initialise object defaults */ + /* initialize object defaults */ animviz_settings_init(&ob->avs); /* if armature, copy settings for pose from armature data @@ -11895,7 +11895,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) if (brush->curve) brush->curve->preset = CURVE_PRESET_SMOOTH; } - /* properly initialise active flag for fluidsim modifiers */ + /* properly initialize active flag for fluidsim modifiers */ for(ob = main->object.first; ob; ob = ob->id.next) { ModifierData *md; for(md= ob->modifiers.first; md; md= md->next) { @@ -12052,7 +12052,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) } } - /* initialise scene active layer */ + /* initialize scene active layer */ for (scene= main->scene.first; scene; scene=scene->id.next) { int i; for(i=0; i<20; i++) { @@ -12422,7 +12422,7 @@ static void do_versions(FileData *fd, Library *lib, Main *main) /* redraws flag in SpaceTime has been moved to Screen level */ for (sc = main->screen.first; sc; sc= sc->id.next) { if (sc->redraws_flag == 0) { - /* just initialise to default? */ + /* just initialize to default? */ // XXX: we could also have iterated through areas, and taken them from the first timeline available... sc->redraws_flag = TIME_ALL_3D_WIN|TIME_ALL_ANIM_WIN; } diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c index b063a1656ab..10e142f08bb 100644 --- a/source/blender/blenloader/intern/writefile.c +++ b/source/blender/blenloader/intern/writefile.c @@ -231,9 +231,9 @@ static void writedata_free(WriteData *wd) /** * Low level WRITE(2) wrapper that buffers data - * @param adr Pointer to new chunk of data - * @param len Length of new chunk of data - * @warning Talks to other functions with global parameters + * \param adr Pointer to new chunk of data + * \param len Length of new chunk of data + * \warning Talks to other functions with global parameters */ #define MYWRITE_FLUSH NULL @@ -284,10 +284,10 @@ static void mywrite( WriteData *wd, void *adr, int len) /** * BeGiN initializer for mywrite - * @param file File descriptor - * @param compare Previous memory file (can be NULL). - * @param current The current memory file (can be NULL). - * @warning Talks to other functions with global parameters + * \param file File descriptor + * \param compare Previous memory file (can be NULL). + * \param current The current memory file (can be NULL). + * \warning Talks to other functions with global parameters */ static WriteData *bgnwrite(int file, MemFile *compare, MemFile *current) { @@ -305,9 +305,9 @@ static WriteData *bgnwrite(int file, MemFile *compare, MemFile *current) /** * END the mywrite wrapper - * @return 1 if write failed - * @return unknown global variable otherwise - * @warning Talks to other functions with global parameters + * \return 1 if write failed + * \return unknown global variable otherwise + * \warning Talks to other functions with global parameters */ static int endwrite(WriteData *wd) { |