Cleanup: use doxy-sections for pipeline, text_drag & effects

Also improve on the doc-string for RE_RenderFrame & RE_RenderAnim.

1 files changed, 7 insertions, 3 deletions

diff --git a/source/blender/render/RE_pipeline.h b/source/blender/render/RE_pipeline.h
index 2d43aa7b27f..f532c705534 100644
--- a/source/blender/render/RE_pipeline.h
+++ b/source/blender/render/RE_pipeline.h
@@ -322,9 +322,13 @@ bool RE_WriteRenderViewsMovie(struct ReportList *reports,
                               bool preview);
 
 /**
- * Only #RE_NewRender() needed, main Blender render calls.
- *
  * General Blender frame render call.
+ *
+ * \note Only #RE_NewRender() needed, main Blender render calls.
+ *
+ * \param write_still: Saves frames to disk (typically disabled). Useful for batch-operations
+ * (rendering from Python for e.g.) when an additional save action for is inconvenient.
+ * This is the default behavior for #RE_RenderAnim.
  */
 void RE_RenderFrame(struct Render *re,
                     struct Main *bmain,
@@ -334,7 +338,7 @@ void RE_RenderFrame(struct Render *re,
                     int frame,
                     bool write_still);
 /**
- * Saves images to disk.
+ * A version of #RE_RenderFrame that saves images to disk.
  */
 void RE_RenderAnim(struct Render *re,
                    struct Main *bmain,