diff options
Diffstat (limited to 'source/blender/blenloader')
| -rw-r--r-- | source/blender/blenloader/intern/readblenentry.c | 40 | ||||
| -rw-r--r-- | source/blender/blenloader/intern/readfile.c | 56 | ||||
| -rw-r--r-- | source/blender/blenloader/intern/writefile.c | 8 |
3 files changed, 52 insertions, 52 deletions
diff --git a/source/blender/blenloader/intern/readblenentry.c b/source/blender/blenloader/intern/readblenentry.c index 0d8f056e9c4..f4c0186e750 100644 --- a/source/blender/blenloader/intern/readblenentry.c +++ b/source/blender/blenloader/intern/readblenentry.c @@ -75,8 +75,8 @@ void BLO_blendhandle_print_sizes(BlendHandle *, void *); /** * Open a blendhandle from a file path. * - * \param filepath The file path to open. - * \param reports Report errors in opening the file (can be NULL). + * \param filepath: 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(const char *filepath, ReportList *reports) @@ -91,8 +91,8 @@ BlendHandle *BLO_blendhandle_from_file(const char *filepath, ReportList *reports /** * Open a blendhandle from memory. * - * \param mem The data to load from. - * \param memsize The size of the data. + * \param mem: The data to load from. + * \param memsize: The size of the data. * \return A handle on success, or NULL on failure. */ BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize) @@ -137,9 +137,9 @@ void BLO_blendhandle_print_sizes(BlendHandle *bh, void *fp) /** * Gets the names of all the datablocks in a file of a certain type (e.g. 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. + * \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. */ LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, int *tot_names) @@ -167,9 +167,9 @@ LinkNode *BLO_blendhandle_get_datablock_names(BlendHandle *bh, int ofblocktype, /** * Gets the previews of all the datablocks in a file of a certain type (e.g. all the scene previews 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. + * \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. */ LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *tot_prev) @@ -265,7 +265,7 @@ LinkNode *BLO_blendhandle_get_previews(BlendHandle *bh, int ofblocktype, int *to /** * Gets the names of all the linkable datablock types available in a file. (e.g. "Scene", "Mesh", "Lamp", etc.). * - * \param bh The blendhandle to access. + * \param bh: The blendhandle to access. * \return A BLI_linklist of strings. The string links should be freed with malloc. */ LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh) @@ -298,7 +298,7 @@ LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh) /** * 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(BlendHandle *bh) { @@ -313,8 +313,8 @@ void BLO_blendhandle_close(BlendHandle *bh) * Open a blender file from a pathname. The function 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 indicating the cause of the failure. + * \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. */ BlendFileData *BLO_read_from_file( @@ -340,9 +340,9 @@ BlendFileData *BLO_read_from_file( * Open a blender file from memory. The function 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 indicating the cause of the failure. + * \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. */ BlendFileData *BLO_read_from_memory( @@ -367,8 +367,8 @@ BlendFileData *BLO_read_from_memory( /** * Used for undo/redo, skips part of libraries reading (assuming their data are already loaded & valid). * - * \param oldmain old main, from which we will keep libraries and other datablocks that should not have changed. - * \param filename current file, only for retrieving library data. + * \param oldmain: old main, from which we will keep libraries and other datablocks that should not have changed. + * \param filename: current file, only for retrieving library data. */ BlendFileData *BLO_read_from_memfile( Main *oldmain, const char *filename, MemFile *memfile, @@ -463,7 +463,7 @@ BlendFileData *BLO_read_from_memfile( /** * Frees a BlendFileData structure and *all* the 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(BlendFileData *bfd) { diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c index 8d89620cdec..27bdc1b5d00 100644 --- a/source/blender/blenloader/intern/readfile.c +++ b/source/blender/blenloader/intern/readfile.c @@ -1353,7 +1353,7 @@ void blo_freefiledata(FileData *fd) /** * Check whether given path ends with a blend file compatible extension (.blend, .ble or .blend.gz). * - * \param str The path to check. + * \param str: The path to check. * \return true is this path ends with a blender file extension. */ bool BLO_has_bfile_extension(const char *str) @@ -1365,11 +1365,11 @@ bool BLO_has_bfile_extension(const char *str) /** * Try to explode given path into its 'library components' (i.e. a .blend file, id type/group, and datablock itself). * - * \param path the full path to explode. - * \param r_dir the string that'll contain path up to blend file itself ('library' path). + * \param path: the full path to explode. + * \param r_dir: the string that'll contain path up to blend file itself ('library' path). * WARNING! Must be FILE_MAX_LIBEXTRA long (it also stores group and name strings)! - * \param r_group the string that'll contain 'group' part of the path, if any. May be NULL. - * \param r_name the string that'll contain data's name part of the path, if any. May be NULL. + * \param r_group: the string that'll contain 'group' part of the path, if any. May be NULL. + * \param r_name: the string that'll contain data's name part of the path, if any. May be NULL. * \return true if path contains a blend file. */ bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name) @@ -1431,7 +1431,7 @@ bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, cha /** * Does a very light reading of given .blend file to extract its stored thumbnail. * - * \param filepath The path of the file to extract thumbnail from. + * \param filepath: The path of the file to extract thumbnail from. * \return The raw thumbnail * (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image). */ @@ -9863,7 +9863,7 @@ static void expand_gpencil(FileData *fd, Main *mainvar, bGPdata *gpd) /** * Set the callback func used over all ID data found by \a BLO_expand_main func. * - * \param expand_doit_func Called for each ID block it finds. + * \param expand_doit_func: Called for each ID block it finds. */ void BLO_main_expander(BLOExpandDoitCallback expand_doit_func) { @@ -9874,8 +9874,8 @@ void BLO_main_expander(BLOExpandDoitCallback expand_doit_func) * Loop over all ID data in Main to mark relations. * Set (id->tag & LIB_TAG_NEED_EXPAND) to mark expanding. Flags get cleared after expanding. * - * \param fdhandle usually filedata, or own handle. - * \param mainvar the Main database to expand. + * \param fdhandle: usually filedata, or own handle. + * \param mainvar: the Main database to expand. */ void BLO_expand_main(void *fdhandle, Main *mainvar) { @@ -10244,10 +10244,10 @@ static ID *link_named_part_ex( /** * Link 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 idcode The kind of datablock to link. - * \param name The name of the datablock (without the 2 char ID prefix). + * \param mainl: The main database to link from (not the active one). + * \param bh: The blender file handle. + * \param idcode: The kind of datablock to link. + * \param name: The name of the datablock (without the 2 char ID prefix). * \return the linked ID when found. */ ID *BLO_library_link_named_part(Main *mainl, BlendHandle **bh, const short idcode, const char *name) @@ -10260,13 +10260,13 @@ ID *BLO_library_link_named_part(Main *mainl, BlendHandle **bh, const short idcod * Link a named datablock from an external blend file. * Optionally instantiate the object/group in the scene when the flags are set. * - * \param mainl The main database to link from (not the active one). - * \param bh The blender file handle. - * \param idcode The kind of datablock to link. - * \param name The name of the datablock (without the 2 char ID prefix). - * \param flag Options for linking, used for instantiating. - * \param scene The scene in which to instantiate objects/groups (if NULL, no instantiation is done). - * \param v3d The active View3D (only to define active layers for instantiated objects & groups, can be NULL). + * \param mainl: The main database to link from (not the active one). + * \param bh: The blender file handle. + * \param idcode: The kind of datablock to link. + * \param name: The name of the datablock (without the 2 char ID prefix). + * \param flag: Options for linking, used for instantiating. + * \param scene: The scene in which to instantiate objects/groups (if NULL, no instantiation is done). + * \param v3d: The active View3D (only to define active layers for instantiated objects & groups, can be NULL). * \return the linked ID when found. */ ID *BLO_library_link_named_part_ex( @@ -10350,9 +10350,9 @@ static Main *library_link_begin(Main *mainvar, FileData **fd, const char *filepa /** * Initialize the BlendHandle for linking library data. * - * \param mainvar The current main database, e.g. G_MAIN or CTX_data_main(C). - * \param bh A blender file handle as returned by \a BLO_blendhandle_from_file or \a BLO_blendhandle_from_memory. - * \param filepath Used for relative linking, copied to the \a lib->name. + * \param mainvar: The current main database, e.g. G_MAIN or CTX_data_main(C). + * \param bh: A blender file handle as returned by \a BLO_blendhandle_from_file or \a BLO_blendhandle_from_memory. + * \param filepath: Used for relative linking, copied to the \a lib->name. * \return the library Main, to be passed to \a BLO_library_append_named_part as \a mainl. */ Main *BLO_library_link_begin(Main *mainvar, BlendHandle **bh, const char *filepath) @@ -10469,11 +10469,11 @@ static void library_link_end(Main *mainl, FileData **fd, const short flag, Scene * Optionally instance the indirect object/group in the scene when the flags are set. * \note Do not use \a bh after calling this function, it may frees it. * - * \param mainl The main database to link from (not the active one). - * \param bh The blender file handle (WARNING! may be freed by this function!). - * \param flag Options for linking, used for instantiating. - * \param scene The scene in which to instantiate objects/groups (if NULL, no instantiation is done). - * \param v3d The active View3D (only to define active layers for instantiated objects & groups, can be NULL). + * \param mainl: The main database to link from (not the active one). + * \param bh: The blender file handle (WARNING! may be freed by this function!). + * \param flag: Options for linking, used for instantiating. + * \param scene: The scene in which to instantiate objects/groups (if NULL, no instantiation is done). + * \param v3d: The active View3D (only to define active layers for instantiated objects & groups, can be NULL). */ void BLO_library_link_end(Main *mainl, BlendHandle **bh, short flag, Scene *scene, View3D *v3d) { diff --git a/source/blender/blenloader/intern/writefile.c b/source/blender/blenloader/intern/writefile.c index baec40335b2..7a915f6b8ca 100644 --- a/source/blender/blenloader/intern/writefile.c +++ b/source/blender/blenloader/intern/writefile.c @@ -403,8 +403,8 @@ static void mywrite_flush(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 + * \param adr: Pointer to new chunk of data + * \param len: Length of new chunk of data */ static void mywrite(WriteData *wd, const void *adr, int len) { @@ -453,8 +453,8 @@ static void mywrite(WriteData *wd, const void *adr, int len) /** * BeGiN initializer for mywrite * \param ww: File write wrapper. - * \param compare Previous memory file (can be NULL). - * \param current The current memory file (can be NULL). + * \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 *mywrite_begin(WriteWrap *ww, MemFile *compare, MemFile *current) |