Cleanup: move public doc-strings into headers for 'editors'

Ref T92709

1 files changed, 24 insertions, 0 deletions

diff --git a/source/blender/editors/include/ED_curve.h b/source/blender/editors/include/ED_curve.h
index 44c5897d3a3..805d42b6fbc 100644
--- a/source/blender/editors/include/ED_curve.h
+++ b/source/blender/editors/include/ED_curve.h
@@ -43,14 +43,22 @@ struct wmKeyConfig;
 struct wmOperator;
 
 /* curve_ops.c */
+
 void ED_operatortypes_curve(void);
 void ED_operatormacros_curve(void);
 void ED_keymap_curve(struct wmKeyConfig *keyconf);
 
 /* editcurve.c */
+
 struct ListBase *object_editcurve_get(struct Object *ob);
 
+/**
+ * Load editNurb in object.
+ */
 void ED_curve_editnurb_load(struct Main *bmain, struct Object *obedit);
+/**
+ * Make copy in `cu->editnurb`.
+ */
 void ED_curve_editnurb_make(struct Object *obedit);
 void ED_curve_editnurb_free(struct Object *obedit);
 
@@ -65,9 +73,14 @@ int ED_curve_nurb_select_count(const struct View3D *v3d, const struct Nurb *nu);
 bool ED_curve_nurb_select_all(const struct Nurb *nu);
 bool ED_curve_nurb_deselect_all(const struct Nurb *nu);
 
+/**
+ * This is used externally, by #OBJECT_OT_join.
+ * TODO: shape keys - as with meshes.
+ */
 int ED_curve_join_objects_exec(struct bContext *C, struct wmOperator *op);
 
 /* editcurve_select.c */
+
 bool ED_curve_select_check(const struct View3D *v3d, const struct EditNurb *editnurb);
 bool ED_curve_deselect_all(struct EditNurb *editnurb);
 bool ED_curve_deselect_all_multi_ex(struct Base **bases, int bases_len);
@@ -77,9 +90,12 @@ bool ED_curve_select_swap(struct EditNurb *editnurb, bool hide_handles);
 int ED_curve_select_count(const struct View3D *v3d, const struct EditNurb *editnurb);
 
 /* editcurve_undo.c */
+
+/** Export for ED_undo_sys */
 void ED_curve_undosys_type(struct UndoType *ut);
 
 /* editfont.c */
+
 void ED_curve_editfont_load(struct Object *obedit);
 void ED_curve_editfont_make(struct Object *obedit);
 void ED_curve_editfont_free(struct Object *obedit);
@@ -92,14 +108,22 @@ void ED_curve_beztcpy(struct EditNurb *editnurb,
                       int count);
 void ED_curve_bpcpy(struct EditNurb *editnurb, struct BPoint *dst, struct BPoint *src, int count);
 
+/**
+ * Return 0 if animation data wasn't changed, 1 otherwise.
+ */
 int ED_curve_updateAnimPaths(struct Main *bmain, struct Curve *cu);
 
 bool ED_curve_active_center(struct Curve *cu, float center[3]);
 
+/**
+ * TextBox selection
+ */
 bool ED_curve_editfont_select_pick(
     struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
 
 /* editfont_undo.c */
+
+/** Export for ED_undo_sys. */
 void ED_font_undosys_type(struct UndoType *ut);
 
 #if 0