[geany/geany] 78644a: msgwin: improve doxygen comments
Thomas Martitz
git-noreply at xxxxx
Thu Apr 5 19:44:43 UTC 2018
Branch: refs/heads/master
Author: Thomas Martitz <kugel at rockbox.org>
Committer: Colomban Wendling <ban at herbesfolles.org>
Date: Thu, 05 Apr 2018 19:44:43 UTC
Commit: 78644a8260ae6ee1e8828ad4330275d4685c7a1c
https://github.com/geany/geany/commit/78644a8260ae6ee1e8828ad4330275d4685c7a1c
Log Message:
-----------
msgwin: improve doxygen comments
Make the brief text be distinct between msgwin_*_add and msgwin_*_add_string().
Also add @see directives where appropriate. Lastly, add @since to
msgwin_status_add() for completeness.
Modified Paths:
--------------
src/msgwindow.c
Modified: src/msgwindow.c
26 lines changed, 20 insertions(+), 6 deletions(-)
===================================================================
@@ -317,13 +317,15 @@ static const GdkColor *get_color(gint msg_color)
/**
- * Adds a new message in the compiler tab treeview in the messages window.
+ * Adds a formatted message in the compiler tab treeview in the messages window.
*
* @param msg_color A color to be used for the text. It must be an element of #MsgColors.
* @param format @c printf()-style format string.
* @param ... Arguments for the @c format string.
*
- * @since 0.15
+ * @see msgwin_compiler_add_string()
+ *
+ * @since 0.16
**/
GEANY_API_SYMBOL
void msgwin_compiler_add(gint msg_color, const gchar *format, ...)
@@ -344,6 +346,8 @@ void msgwin_compiler_add(gint msg_color, const gchar *format, ...)
* @param msg_color A color to be used for the text. It must be an element of #MsgColors.
* @param msg Compiler message to be added.
*
+ * @see msgwin_compiler_add()
+ *
* @since @todo
**/
GEANY_API_SYMBOL
@@ -395,7 +399,7 @@ void msgwin_show_hide(gboolean show)
/**
- * Adds a new message in the messages tab treeview in the messages window.
+ * Adds a formatted message in the messages tab treeview in the messages window.
*
* If @a line and @a doc are set, clicking on this line jumps into the file
* which is specified by @a doc into the line specified with @a line.
@@ -406,7 +410,9 @@ void msgwin_show_hide(gboolean show)
* @param format @c printf()-style format string.
* @param ... Arguments for the @c format string.
*
- * @since 0.15
+ * @see msgwin_msg_add_string()
+ *
+ * @since 0.16
**/
GEANY_API_SYMBOL
void msgwin_msg_add(gint msg_color, gint line, GeanyDocument *doc, const gchar *format, ...)
@@ -434,6 +440,8 @@ void msgwin_msg_add(gint msg_color, gint line, GeanyDocument *doc, const gchar *
* @param doc @nullable The document. Set to @c NULL to ignore.
* @param string Message to be added.
*
+ * @see msgwin_msg_add()
+ *
* @since @todo
**/
GEANY_API_SYMBOL
@@ -474,12 +482,14 @@ void msgwin_msg_add_string(gint msg_color, gint line, GeanyDocument *doc, const
/**
- * Logs a status message *without* setting the status bar.
+ * Logs a new status message *without* setting the status bar.
*
* Use @ref ui_set_statusbar() to display text on the statusbar.
*
* @param string Status message to be logged.
*
+ * @see msgwin_status_add()
+ *
* @since @todo
**/
GEANY_API_SYMBOL
@@ -510,12 +520,16 @@ void msgwin_status_add_string(const gchar *string)
}
/**
- * Logs a status message *without* setting the status bar.
+ * Logs a formatted status message *without* setting the status bar.
*
* Use @ref ui_set_statusbar() to display text on the statusbar.
*
* @param format @c printf()-style format string.
* @param ... Arguments for the @c format string.
+ *
+ * @see msgwin_status_add_string()
+ *
+ * @since 0.12
**/
GEANY_API_SYMBOL
void msgwin_status_add(const gchar *format, ...)
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
More information about the Commits
mailing list