Doxygen (documenting each built-in rendering function for widgets)

1 files changed, 27 insertions, 0 deletions

diff --git a/src/gwin/gwin_textedit.h b/src/gwin/gwin_textedit.h
index f39f0c2a..8b3336e2 100644
--- a/src/gwin/gwin_textedit.h
+++ b/src/gwin/gwin_textedit.h
@@ -60,6 +60,33 @@ extern "C" {
 GHandle gwinGTexteditCreate(GDisplay* g, GTexteditObject* wt, GWidgetInit* pInit, size_t maxSize);
 #define gwinTexteditCreate(wt, pInit, maxSize)			gwinGTexteditCreate(GDISP, wt, pInit, maxSize)
 
+/**
+ * @defgroup Renderings_Textedit Textedit rendering functions
+ *
+ * @brief				Built-in rendering functions for the textedit widget.
+ *
+ * @details				These function may be passed to @p gwinSetCustomDraw() to get different textedit drawing styles.
+ *
+ * @note				In your custom textedit drawing function you may optionally call these
+ * 						standard functions and then draw your extra details on top.
+ * @note				These custom drawing routines don't have to worry about setting clipping as the framework
+ * 						sets clipping to the object window prior to calling these routines.
+ *
+ * @{
+ */
+
+/**
+ * @brief				The default rendering function for the textedit widget.
+ *
+ * @param[in] gw		The widget object (must be a button textedit).
+ * @param[in] param		A parameter passed in from the user. Ignored by this function.
+ *
+ * @api
+ */
+void gwinTexteditDefaultDraw(GWidgetObject* gw, void* param);
+
+/** @} */
+
 #ifdef __cplusplus
 }
 #endif