From 7e927174396443cdc4c5544dad13faca7299d183 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Wed, 8 Dec 2021 17:12:41 +1100
Subject: Cleanup: move public doc-strings into headers for 'windowmanager'

Ref T92709
---
 .../windowmanager/intern/wm_operator_type.c        | 33 ++--------------------
 1 file changed, 2 insertions(+), 31 deletions(-)

(limited to 'source/blender/windowmanager/intern/wm_operator_type.c')

diff --git a/source/blender/windowmanager/intern/wm_operator_type.c b/source/blender/windowmanager/intern/wm_operator_type.c
index 0e30df4ec99..0f6096e7b8b 100644
--- a/source/blender/windowmanager/intern/wm_operator_type.c
+++ b/source/blender/windowmanager/intern/wm_operator_type.c
@@ -89,7 +89,6 @@ wmOperatorType *WM_operatortype_find(const char *idname, bool quiet)
   return NULL;
 }
 
-/* caller must free */
 void WM_operatortype_iter(GHashIterator *ghi)
 {
   BLI_ghashIterator_init(ghi, global_ops_hash);
@@ -132,7 +131,8 @@ static void wm_operatortype_append__end(wmOperatorType *ot)
   BLI_ghash_insert(global_ops_hash, (void *)ot->idname, ot);
 }
 
-/* all ops in 1 list (for time being... needs evaluation later) */
+/* All ops in 1 list (for time being... needs evaluation later). */
+
 void WM_operatortype_append(void (*opfunc)(wmOperatorType *))
 {
   wmOperatorType *ot = wm_operatortype_append__begin();
@@ -149,7 +149,6 @@ void WM_operatortype_append_ptr(void (*opfunc)(wmOperatorType *, void *), void *
 
 /** \} */
 
-/* called on initialize WM_exit() */
 void WM_operatortype_remove_ptr(wmOperatorType *ot)
 {
   BLI_assert(ot == WM_operatortype_find(ot->idname, false));
@@ -184,7 +183,6 @@ bool WM_operatortype_remove(const char *idname)
   return true;
 }
 
-/* called on initialize WM_init() */
 void wm_operatortype_init(void)
 {
   /* reserve size is set based on blender default setup */
@@ -215,18 +213,6 @@ void wm_operatortype_free(void)
   global_ops_hash = NULL;
 }
 
-/**
- * Tag all operator-properties of \a ot defined after calling this, until
- * the next #WM_operatortype_props_advanced_end call (if available), with
- * #OP_PROP_TAG_ADVANCED. Previously defined ones properties not touched.
- *
- * Calling this multiple times without a call to #WM_operatortype_props_advanced_end,
- * all calls after the first one are ignored. Meaning all proprieties defined after the
- * first call are tagged as advanced.
- *
- * This doesn't do the actual tagging, #WM_operatortype_props_advanced_end does which is
- * called for all operators during registration (see #wm_operatortype_append__end).
- */
 void WM_operatortype_props_advanced_begin(wmOperatorType *ot)
 {
   if (ot_prop_basic_count == -1) {
@@ -235,14 +221,6 @@ void WM_operatortype_props_advanced_begin(wmOperatorType *ot)
   }
 }
 
-/**
- * Tags all operator-properties of \a ot defined since the first
- * #WM_operatortype_props_advanced_begin call,
- * or the last #WM_operatortype_props_advanced_end call, with #OP_PROP_TAG_ADVANCED.
- *
- * \note This is called for all operators during registration (see #wm_operatortype_append__end).
- * So it does not need to be explicitly called in operator-type definition.
- */
 void WM_operatortype_props_advanced_end(wmOperatorType *ot)
 {
   PointerRNA struct_ptr;
@@ -266,9 +244,6 @@ void WM_operatortype_props_advanced_end(wmOperatorType *ot)
   ot_prop_basic_count = -1;
 }
 
-/**
- * Remove memory of all previously executed tools.
- */
 void WM_operatortype_last_properties_clear_all(void)
 {
   GHashIterator iter;
@@ -471,7 +446,6 @@ static void wm_macro_cancel(bContext *C, wmOperator *op)
   wm_macro_end(op, OPERATOR_CANCELLED);
 }
 
-/* Names have to be static for now */
 wmOperatorType *WM_operatortype_append_macro(const char *idname,
                                              const char *name,
                                              const char *description,
@@ -613,9 +587,6 @@ char *WM_operatortype_description(struct bContext *C,
   return NULL;
 }
 
-/**
- * Use when we want a label, preferring the description.
- */
 char *WM_operatortype_description_or_name(struct bContext *C,
                                           struct wmOperatorType *ot,
                                           struct PointerRNA *properties)
-- 
cgit v1.2.3