Merge branch 'master' into soc-2021-uv-edge-select-supportsoc-2021-uv-edge-select-support

1 files changed, 17 insertions, 0 deletions

diff --git a/source/blender/editors/include/ED_outliner.h b/source/blender/editors/include/ED_outliner.h
index 1d1471f0be6..99f65010595 100644
--- a/source/blender/editors/include/ED_outliner.h
+++ b/source/blender/editors/include/ED_outliner.h
@@ -33,10 +33,21 @@ struct bContext;
 
 bool ED_outliner_collections_editor_poll(struct bContext *C);
 
+/**
+ * Populates the \param objects: ListBase with all the outliner selected objects
+ * We store it as (Object *)LinkData->data
+ * \param objects: expected to be empty
+ */
 void ED_outliner_selected_objects_get(const struct bContext *C, struct ListBase *objects);
 
+/**
+ * Get base of object under cursor. Used for eyedropper tool.
+ */
 struct Base *ED_outliner_give_base_under_cursor(struct bContext *C, const int mval[2]);
 
+/**
+ * Functions for tagging outliner selection syncing is dirty from operators.
+ */
 void ED_outliner_select_sync_from_object_tag(struct bContext *C);
 void ED_outliner_select_sync_from_edit_bone_tag(struct bContext *C);
 void ED_outliner_select_sync_from_pose_bone_tag(struct bContext *C);
@@ -45,9 +56,15 @@ void ED_outliner_select_sync_from_all_tag(struct bContext *C);
 
 bool ED_outliner_select_sync_is_dirty(const struct bContext *C);
 
+/**
+ * Set clean outliner and mark other outliners for syncing.
+ */
 void ED_outliner_select_sync_from_outliner(struct bContext *C,
                                            struct SpaceOutliner *space_outliner);
 
+/**
+ * Copy sync select dirty flag from window manager to all outliners to be synced lazily on draw.
+ */
 void ED_outliner_select_sync_flag_outliners(const struct bContext *C);
 
 #ifdef __cplusplus