[gtkmm/wip/dboles/builder-retval-3] Builder: Fix wrong use of @retval for output args:



commit 429a5a4658f86bf9c4eec49a6af3722558390212
Author: Daniel Boles <dboles src gnome org>
Date:   Sun Dec 16 21:37:11 2018 +0000

    Builder: Fix wrong use of @retval for output args:
    
    @retval is for documenting the meanings of particular values of the
    returned variable, not output reference/pointer arguments like this.

 gtk/src/builder.hg | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/gtk/src/builder.hg b/gtk/src/builder.hg
index dccbd0ea..a7b7bfe9 100644
--- a/gtk/src/builder.hg
+++ b/gtk/src/builder.hg
@@ -457,7 +457,7 @@ public:
    * container widget.
    *
    * @param name The name of the widget.
-   * @retval widget A pointer to the widget, or <tt>nullptr</tt> on failure.
+   * @param[out] widget A pointer to the widget, or <tt>nullptr</tt> on failure.
    */
   template <class T_Widget> inline
   void get_widget(const Glib::ustring& name, T_Widget*& widget)
@@ -512,7 +512,7 @@ public:
    *
    * @param name The name of the widget.
    * @param args Additional arguments to pass to the constructor of the derived class.
-   * @retval widget A pointer to the widget, or <tt>nullptr</tt> on failure.
+   * @param[out] widget A pointer to the widget, or <tt>nullptr</tt> on failure.
    */
   template <typename T_Widget, typename... Args> inline
   void get_widget_derived(const Glib::ustring& name, T_Widget*& widget, Args&&... args)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]