[Bf-blender-cvs] [8f45e11] master: Docs: comment BKE_scene_set_background

[Campbell Barton]

Commit: 8f45e1156f13ee6d3dc9393a2a20a901503a9762
Author: Campbell Barton
Date:   Thu Aug 6 21:02:08 2015 +1000
Branches: master
https://developer.blender.org/rB8f45e1156f13ee6d3dc9393a2a20a901503a9762

Docs: comment BKE_scene_set_background

===================================================================

M	source/blender/blenkernel/intern/scene.c

===================================================================

diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c
index e268724..b518ae4 100644
--- a/source/blender/blenkernel/intern/scene.c
+++ b/source/blender/blenkernel/intern/scene.c
@@ -756,6 +756,11 @@ Base *BKE_scene_base_find(Scene *scene, Object *ob)
 	return BLI_findptr(&scene->base, ob, offsetof(Base, object));
 }
 
+/**
+ * Sets the active scene, mainly used when running in background mode (``--scene`` command line argument).
+ * This is also called to set the scene directly, bypassing windowing code.
+ * Otherwise #ED_screen_set_scene is used when changing scenes by the user.
+ */
 void BKE_scene_set_background(Main *bmain, Scene *scene)
 {
 	Scene *sce;