Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2016-03-03 04:35:33 +0300
committerCampbell Barton <ideasman42@gmail.com>2016-03-03 04:36:33 +0300
commit8fa1d705433fed919fbfb713b26ed9cad820c549 (patch)
treeef618fb8cd31e42f767e22054ce69933643474fa /source/creator
parent2177f645855c242399f3d3324f4d8e0357c3601c (diff)
Cleanup: comments for creator_args & line length
Diffstat (limited to 'source/creator')
-rw-r--r--source/creator/creator_args.c21
1 files changed, 17 insertions, 4 deletions
diff --git a/source/creator/creator_args.c b/source/creator/creator_args.c
index 0df5e935b5c..2f7fce72de8 100644
--- a/source/creator/creator_args.c
+++ b/source/creator/creator_args.c
@@ -269,6 +269,16 @@ static void arg_py_context_restore(
/* -------------------------------------------------------------------- */
/** \name Handle Argument Callbacks
+ *
+ * \note Doc strings here are used in differently:
+ *
+ * - The `--help` message.
+ * - The man page (for Unix systems),
+ * see: `doc/manpage/blender.1.py`
+ * - Parsed and extracted for the manual,
+ * which converts our ad-hoc formatting to reStructuredText.
+ * see: http://www.blender.org/manual/advanced/command_line.html
+ *
* \{ */
static const char arg_handle_print_version_doc[] =
@@ -417,7 +427,7 @@ static int arg_handle_print_help(int UNUSED(argc), const char **UNUSED(argv), vo
BLI_argsPrintOtherDoc(ba);
printf("\n");
- printf("Experimental features:\n");
+ printf("Experimental Features:\n");
BLI_argsPrintArgDoc(ba, "--enable-new-depsgraph");
printf("Argument Parsing:\n");
@@ -910,7 +920,8 @@ static int arg_handle_engine_set(int argc, const char **argv, void *data)
}
}
else {
- printf("\nError: no blend loaded. order the arguments so '-E / --engine ' is after a blend is loaded.\n");
+ printf("\nError: no blend loaded. "
+ "order the arguments so '-E / --engine ' is after a blend is loaded.\n");
}
}
@@ -947,7 +958,8 @@ static int arg_handle_image_type_set(int argc, const char **argv, void *data)
}
}
else {
- printf("\nError: no blend loaded. order the arguments so '-F / --render-format' is after the blend is loaded.\n");
+ printf("\nError: no blend loaded. "
+ "order the arguments so '-F / --render-format' is after the blend is loaded.\n");
}
return 1;
}
@@ -1043,7 +1055,8 @@ static int arg_handle_extension_set(int argc, const char **argv, void *data)
}
}
else {
- printf("\nError: no blend loaded. order the arguments so '-o ' is after '-x '.\n");
+ printf("\nError: no blend loaded. "
+ "order the arguments so '-o ' is after '-x '.\n");
}
return 1;
}