From 9f22750422940681dba14839a762c6f8bf02dba6 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 4 Jul 2012 20:47:12 +0000 Subject: style cleanup --- source/blender/blenlib/BLI_args.h | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) (limited to 'source/blender/blenlib/BLI_args.h') diff --git a/source/blender/blenlib/BLI_args.h b/source/blender/blenlib/BLI_args.h index 7a240e0e08a..6758fa399a4 100644 --- a/source/blender/blenlib/BLI_args.h +++ b/source/blender/blenlib/BLI_args.h @@ -36,18 +36,31 @@ struct bArgs; typedef struct bArgs bArgs; -/* returns the number of extra arguments consumed by the function. 0 is normal value, -1 stops parsing arguments, other negative indicates skip */ +/** + * Returns the number of extra arguments consumed by the function. + * - 0 is normal value, + * - -1 stops parsing arguments, other negative indicates skip + */ typedef int (*BA_ArgCallback)(int argc, const char **argv, void *data); struct bArgs *BLI_argsInit(int argc, const char **argv); void BLI_argsFree(struct bArgs *ba); -/* pass starts at 1, -1 means valid all the time +/** + * Pass starts at 1, -1 means valid all the time * short_arg or long_arg can be null to specify no short or long versions - * */ -void BLI_argsAdd(struct bArgs *ba, int pass, const char *short_arg, const char *long_arg, const char *doc, BA_ArgCallback cb, void *data); -/* short_case and long_case specify if those arguments are case specific */ -void BLI_argsAddCase(struct bArgs *ba, int pass, const char *short_arg, int short_case, const char *long_arg, int long_case, const char *doc, BA_ArgCallback cb, void *data); + */ +void BLI_argsAdd(struct bArgs *ba, int pass, + const char *short_arg, const char *long_arg, + const char *doc, BA_ArgCallback cb, void *data); + +/** + * Short_case and long_case specify if those arguments are case specific + */ +void BLI_argsAddCase(struct bArgs *ba, int pass, + const char *short_arg, int short_case, + const char *long_arg, int long_case, + const char *doc, BA_ArgCallback cb, void *data); void BLI_argsParse(struct bArgs *ba, int pass, BA_ArgCallback default_cb, void *data); -- cgit v1.2.3