From a3facd9b5fc1a252ef18a7b5a3fca6b1c80cbb01 Mon Sep 17 00:00:00 2001 From: Bernd Jendrisse Date: Sun, 29 Jul 2007 10:20:11 -0400 Subject: [PATCH] Added doxygen comment to o_text_add() --- libgeda/src/o_text_basic.c | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/libgeda/src/o_text_basic.c b/libgeda/src/o_text_basic.c index e6bac7ff5..c98ad8359 100644 --- a/libgeda/src/o_text_basic.c +++ b/libgeda/src/o_text_basic.c @@ -865,9 +865,28 @@ OBJECT *o_text_create_string(TOPLEVEL *w_current, OBJECT *object_list, } /*! \todo Finish function documentation!!! - * \brief + * \brief Creates a text OBJECT and the graphical objects representing it * \par Function Description + * Create an OBJECT of type OBJ_TEXT and link it to the end of object_list. + * Also add the OBJECTs forming the graphical representation of the visible + * string, to the text OBJECT's prim_objs list. + * + * \param [in] w_current The TOPLEVEL object. + * \param [in] object_list OBJECT list onto which to add text. + * \param [in] type OBJ_TEXT (TODO: why bother) + * \param [in] color The color of the text. + * \param [in] x World x coord of text. + * \param [in] y World y coord of text. + * \param [in] alignment How text bounding box aligns on (x, y). + * \param [in] angle Angle at which text will appear. + * \param [in] string The text (TODO: can be char const *)! + * \param [in] size Text size. + * \param [in] visibility VISIBLE or INVISIBLE. + * \param [in] show_name_value SHOW_NAME_VALUE or friends. + * \return Pointer to text OBJECT. * + * \note + * Caller is responsible for string; this function allocates its own copy. */ OBJECT *o_text_add(TOPLEVEL *w_current, OBJECT *object_list, char type, int color, int x, int y, int alignment, -- 2.11.4.GIT