[gnome-panel] libgnome-panel: document module id recommendation
- From: Alberts Muktupāvels <muktupavels src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-panel] libgnome-panel: document module id recommendation
- Date: Mon, 31 Jul 2017 15:15:31 +0000 (UTC)
commit 19182221ad7f19f7bc05be3cc8da3a6f25302949
Author: Alberts Muktupāvels <alberts muktupavels gmail com>
Date: Mon Jul 31 14:35:04 2017 +0300
libgnome-panel: document module id recommendation
libgnome-panel/gp-module-info.c | 4 ++++
libgnome-panel/gp-module.h | 3 ++-
2 files changed, 6 insertions(+), 1 deletions(-)
---
diff --git a/libgnome-panel/gp-module-info.c b/libgnome-panel/gp-module-info.c
index 725952c..e817813 100644
--- a/libgnome-panel/gp-module-info.c
+++ b/libgnome-panel/gp-module-info.c
@@ -53,6 +53,10 @@ get_applets (va_list args)
*
* Creates a new #GpModuleInfo.
*
+ * The module @id must be globally unique. For this reason, it is very
+ * strongly recommended to use reverse domain style identifier:
+ * https://wiki.gnome.org/HowDoI/ChooseApplicationID
+ *
* Returns: (transfer full): a newly created #GpModuleInfo.
*/
GpModuleInfo *
diff --git a/libgnome-panel/gp-module.h b/libgnome-panel/gp-module.h
index 6270797..9bc0cad 100644
--- a/libgnome-panel/gp-module.h
+++ b/libgnome-panel/gp-module.h
@@ -41,7 +41,8 @@ G_BEGIN_DECLS
* bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
* bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
*
- * info = gp_module_info_new ("example", PACKAGE_VERSION, GETTEXT_PACKAGE);
+ * info = gp_module_info_new ("org.example.example",
+ * PACKAGE_VERSION, GETTEXT_PACKAGE);
*
* gp_module_info_set_applets (info, "example1", "example2", NULL);
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]