[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [58346] trunk/blender/source/blender/ makesrna/intern/rna_wm_api.c: Added some documentation for the minimal progress bar in blender_python_api

[Gaia Clary]

Revision: 58346
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=58346
Author:   gaiaclary
Date:     2013-07-17 17:07:11 +0000 (Wed, 17 Jul 2013)
Log Message:
-----------
Added some documentation for the minimal progress bar in blender_python_api

Modified Paths:
--------------
    trunk/blender/source/blender/makesrna/intern/rna_wm_api.c

Modified: trunk/blender/source/blender/makesrna/intern/rna_wm_api.c
===================================================================
--- trunk/blender/source/blender/makesrna/intern/rna_wm_api.c	2013-07-17 15:44:22 UTC (rev 58345)
+++ trunk/blender/source/blender/makesrna/intern/rna_wm_api.c	2013-07-17 17:07:11 UTC (rev 58346)
@@ -333,17 +333,23 @@
 
 	/* Progress bar interface */
 	func = RNA_def_function(srna, "progress_begin", "rna_progress_begin");
+	RNA_def_function_ui_description(func, "Start Progress bar");
+
 	parm = RNA_def_property(func, "min", PROP_FLOAT, PROP_NONE);
+	RNA_def_property_ui_text(parm, "min", "any value in range [0,9999]");
 	RNA_def_property_flag(parm, PROP_REQUIRED);
+
 	parm = RNA_def_property(func, "max", PROP_FLOAT, PROP_NONE);
 	RNA_def_property_flag(parm, PROP_REQUIRED);
+	RNA_def_property_ui_text(parm, "max", "any value in range [min+1,9998]");
 
 	func = RNA_def_function(srna, "progress_update", "rna_progress_update");
 	parm = RNA_def_property(func, "value", PROP_FLOAT, PROP_NONE);
 	RNA_def_property_flag(parm, PROP_REQUIRED);
-	RNA_def_property_ui_text(parm, "value", "any value between min and max as set in progress_init()");
+	RNA_def_property_ui_text(parm, "value", "any value between min and max as set in progress_begin()");
 
 	func = RNA_def_function(srna, "progress_end", "rna_progress_end");
+	RNA_def_function_ui_description(func, "Terminate Progress bar");
 
 	/* invoke functions, for use with python */
 	func = RNA_def_function(srna, "invoke_props_popup", "rna_Operator_props_popup");