[Bf-blender-cvs] [619cbca] render-layers: From review: "doxygen"
Dalai Felinto
noreply at git.blender.org
Wed Dec 21 19:14:55 CET 2016
Commit: 619cbca39f250a76af45a2efbe2feca3005ac32a
Author: Dalai Felinto
Date: Tue Dec 20 11:21:10 2016 +0100
Branches: render-layers
https://developer.blender.org/rB619cbca39f250a76af45a2efbe2feca3005ac32a
>From review: "doxygen"
I do not compile doxygen (assuming it is compiled, I do not even know). But it does not hurt to add the extra * everywhere
===================================================================
M source/blender/blenkernel/BKE_node.h
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/layer.c
===================================================================
diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index d23766b..67f7fa5 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -694,8 +694,6 @@ bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter,
void BKE_nodetree_remove_layer_n(struct bNodeTree *ntree, struct Scene *scene, const int layer_index);
-/** \} */
-
/* -------------------------------------------------------------------- */
/** \name Shader Nodes
*/
diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c
index f2081dc..e32fa4e 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -41,7 +41,7 @@
#include "MEM_guardedalloc.h"
-/*
+/**
* Add a collection to a collection ListBase and syncronize all render layers
* The ListBase is NULL when the collection is to be added to the master collection
*/
@@ -59,7 +59,9 @@ SceneCollection *BKE_collection_add(Scene *scene, SceneCollection *sc_parent, co
return sc;
}
-/* free the collection items recursively */
+/**
+ * Free the collection items recursively
+ */
static void collection_free(SceneCollection *sc)
{
for (LinkData *link = sc->objects.first; link; link = link->next) {
@@ -78,8 +80,10 @@ static void collection_free(SceneCollection *sc)
BLI_freelistN(&sc->scene_collections);
}
-/* unlink the collection recursively
- * return true if unlinked */
+/**
+ * Unlink the collection recursively
+ * return true if unlinked
+ */
static bool collection_remlink(SceneCollection *sc_parent, SceneCollection *sc_gone)
{
for (SceneCollection *sc = sc_parent->scene_collections.first; sc; sc = sc->next)
@@ -96,7 +100,7 @@ static bool collection_remlink(SceneCollection *sc_parent, SceneCollection *sc_g
return false;
}
-/*
+/**
* Recursively remove any instance of this SceneCollection
*/
static void layer_collection_remove(SceneLayer *sl, ListBase *lb, const SceneCollection *sc)
@@ -126,7 +130,7 @@ static void layer_collection_remove(SceneLayer *sl, ListBase *lb, const SceneCol
}
}
-/*
+/**
* Remove a collection from the scene, and syncronize all render layers
*/
bool BKE_collection_remove(Scene *scene, SceneCollection *sc)
@@ -156,7 +160,7 @@ bool BKE_collection_remove(Scene *scene, SceneCollection *sc)
return true;
}
-/*
+/**
* Returns the master collection
*/
SceneCollection *BKE_collection_master(Scene *scene)
@@ -164,7 +168,7 @@ SceneCollection *BKE_collection_master(Scene *scene)
return scene->collection;
}
-/*
+/**
* Free (or release) any data used by the master collection (does not free the master collection itself).
* Used only to clear the entire scene data since it's not doing re-syncing of the LayerCollection tree
*/
@@ -172,7 +176,7 @@ void BKE_collection_master_free(Scene *scene){
collection_free(BKE_collection_master(scene));
}
-/*
+/**
* Add object to collection
*/
void BKE_collection_object_add(struct Scene *UNUSED(scene), struct SceneCollection *sc, struct Object *ob)
@@ -183,7 +187,7 @@ void BKE_collection_object_add(struct Scene *UNUSED(scene), struct SceneCollecti
/* add the equivalent object base to all layers that have this collection */
}
-/*
+/**
* Remove object from collection
*/
void BKE_collection_object_remove(struct Scene *UNUSED(scene), struct SceneCollection *sc, struct Object *ob)
@@ -252,7 +256,7 @@ static void scene_collections_array(Scene *scene, SceneCollection ***collections
scene_collection_callback(sc, scene_collections_build_array, &array);
}
-/*
+/**
* Only use this in non-performance critical situations
* (it iterates over all scene collections twice)
*/
@@ -322,7 +326,9 @@ void BKE_scene_objects_Iterator_begin(Iterator *iter, void *data_in)
iter->current = sc->objects.first;
}
-/* gets the next unique object */
+/**
+ * Gets the next unique object
+ */
static LinkData *object_base_next(GSet *gs, LinkData *link)
{
if (link == NULL) {
diff --git a/source/blender/blenkernel/intern/layer.c b/source/blender/blenkernel/intern/layer.c
index 671b0d8..6c58482 100644
--- a/source/blender/blenkernel/intern/layer.c
+++ b/source/blender/blenkernel/intern/layer.c
@@ -49,7 +49,7 @@ void layer_collection_free(SceneLayer *sl, LayerCollection *lc);
/* RenderLayer */
-/*
+/**
* Add a new renderlayer
* by default, a renderlayer has the master collection
*/
@@ -97,7 +97,7 @@ bool BKE_scene_layer_remove(Main *bmain, Scene *scene, SceneLayer *sl)
return true;
}
-/*
+/**
* Free (or release) any data used by this SceneLayer (does not free the SceneLayer itself).
*/
void BKE_scene_layer_free(SceneLayer *sl)
@@ -111,7 +111,7 @@ void BKE_scene_layer_free(SceneLayer *sl)
BLI_freelistN(&sl->layer_collections);
}
-/*
+/**
* Set the render engine of a renderlayer
*/
void BKE_scene_layer_engine_set(SceneLayer *sl, const char *engine)
@@ -119,7 +119,7 @@ void BKE_scene_layer_engine_set(SceneLayer *sl, const char *engine)
BLI_strncpy_utf8(sl->engine, engine, sizeof(sl->engine));
}
-/*
+/**
* Tag all the selected objects of a renderlayer
*/
void BKE_scene_layer_selected_objects_tag(SceneLayer *sl, const int tag)
@@ -167,7 +167,8 @@ static ObjectBase *object_base_add(SceneLayer *sl, Object *ob)
/* LayerCollection */
-/* When freeing the entire SceneLayer at once we don't bother with unref
+/**
+ * When freeing the entire SceneLayer at once we don't bother with unref
* otherwise SceneLayer is passed to keep the syncing of the LayerCollection tree
*/
void layer_collection_free(SceneLayer *sl, LayerCollection *lc)
@@ -187,7 +188,7 @@ void layer_collection_free(SceneLayer *sl, LayerCollection *lc)
BLI_freelistN(&lc->layer_collections);
}
-/*
+/**
* Free (or release) LayerCollection from SceneLayer
* (does not free the LayerCollection itself).
*/
@@ -198,7 +199,9 @@ void BKE_layer_collection_free(SceneLayer *sl, LayerCollection *lc)
/* LayerCollection */
-/* Recursively get the collection for a given index */
+/**
+ * Recursively get the collection for a given index
+ */
static LayerCollection *collection_from_index(ListBase *lb, const int number, int *i)
{
for (LayerCollection *lc = lb->first; lc; lc = lc->next) {
@@ -216,18 +219,18 @@ static LayerCollection *collection_from_index(ListBase *lb, const int number, in
return NULL;
}
-/*
+/**
* Get the active collection
-*/
+ */
LayerCollection *BKE_layer_collection_active(SceneLayer *sl)
{
int i = 0;
return collection_from_index(&sl->layer_collections, sl->active_collection, &i);
}
-/*
+/**
* Recursively get the count of collections
-*/
+ */
static int collection_count(ListBase *lb)
{
int i = 0;
@@ -237,7 +240,7 @@ static int collection_count(ListBase *lb)
return i;
}
-/*
+/**
* Get the total number of collections
* (including all the nested collections)
*/
@@ -246,7 +249,9 @@ int BKE_layer_collection_count(SceneLayer *sl)
return collection_count(&sl->layer_collections);
}
-/* Recursively get the index for a given collection */
+/**
+ * Recursively get the index for a given collection
+ */
static int index_from_collection(ListBase *lb, LayerCollection *lc, int *i)
{
for (LayerCollection *lcol = lb->first; lcol; lcol = lcol->next) {
@@ -264,7 +269,7 @@ static int index_from_collection(ListBase *lb, LayerCollection *lc, int *i)
return -1;
}
-/*
+/**
* Return -1 if not found
*/
int BKE_layer_collection_findindex(SceneLayer *sl, LayerCollection *lc)
@@ -273,7 +278,7 @@ int BKE_layer_collection_findindex(SceneLayer *sl, LayerCollection *lc)
return index_from_collection(&sl->layer_collections, lc, &i);
}
-/*
+/**
* Link a collection to a renderlayer
* The collection needs to be created separately
*/
@@ -283,7 +288,7 @@ LayerCollection *BKE_collection_link(SceneLayer *sl, SceneCollection *sc)
return lc;
}
-/*
+/**
* Unlink a collection base from a renderlayer
* The corresponding collection is not removed from the master collection
*/
@@ -340,7 +345,7 @@ LayerCollection *layer_collection_add(SceneLayer *sl, ListBase *lb, SceneCollect
/* Override */
-/*
+/**
* Add a new datablock override
*/
void BKE_collection_override_datablock_add(LayerCollection *UNUSED(lc), const char *UNUSED(data_path), ID *UNUSED(id))
More information about the Bf-blender-cvs
mailing list