[amtk] ActionInfo: improve doc of get/set_label()



commit edcd572d2005bdfe5372d547b1e9365002a9e94f
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Apr 14 13:46:36 2018 +0200

    ActionInfo: improve doc of get/set_label()

 amtk/amtk-action-info.c |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
---
diff --git a/amtk/amtk-action-info.c b/amtk/amtk-action-info.c
index 2143e3c..44d72ac 100644
--- a/amtk/amtk-action-info.c
+++ b/amtk/amtk-action-info.c
@@ -1,7 +1,7 @@
 /*
  * This file is part of Amtk - Actions, Menus and Toolbars Kit
  *
- * Copyright 2017 - Sébastien Wilmet <swilmet gnome org>
+ * Copyright 2017, 2018 - Sébastien Wilmet <swilmet gnome org>
  *
  * Amtk is free software; you can redistribute it and/or modify it under
  * the terms of the GNU Lesser General Public License as published by the
@@ -278,7 +278,8 @@ amtk_action_info_set_icon_name (AmtkActionInfo *info,
  * amtk_action_info_get_label:
  * @info: an #AmtkActionInfo.
  *
- * Gets the label. The label has normally a mnemonic.
+ * Gets the label. The label has normally a mnemonic. To remove the mnemonic,
+ * there is the amtk_utils_remove_mnemonic() function.
  *
  * Returns: (nullable): the label (i.e. a short description), or %NULL.
  * Since: 2.0
@@ -296,7 +297,8 @@ amtk_action_info_get_label (const AmtkActionInfo *info)
  * @info: an #AmtkActionInfo.
  * @label: (nullable): the label (i.e. a short description), or %NULL.
  *
- * Sets the label with a mnemonic.
+ * Sets the label with a mnemonic. To know how to encode the mnemonic, see the
+ * documentation of gtk_label_new_with_mnemonic().
  *
  * Since: 2.0
  */


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