doc/sphinx: Include weston-config and shell-utils in docs

libweston contains weston_config and weston_shell_utils utilities
functions so include these in the sphinx documentation as well.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>

1 files changed, 42 insertions, 0 deletions

diff --git a/shared/config-parser.c b/shared/config-parser.c
index cf4adddf..749158df 100644
--- a/shared/config-parser.c
+++ b/shared/config-parser.c
@@ -45,6 +45,12 @@
 #include "helpers.h"
 #include "string-helpers.h"
 
+/**
+ * \defgroup weston-config Weston configuration
+ *
+ * Helper functions to read out ini configuration file.
+ */
+
 struct weston_config_entry {
 	char *key;
 	char *value;
@@ -130,6 +136,9 @@ config_section_get_entry(struct weston_config_section *section,
 	return NULL;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT struct weston_config_section *
 weston_config_get_section(struct weston_config *config, const char *section,
 			  const char *key, const char *value)
@@ -152,6 +161,9 @@ weston_config_get_section(struct weston_config *config, const char *section,
 	return NULL;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_int(struct weston_config_section *section,
 			      const char *key,
@@ -174,6 +186,9 @@ weston_config_section_get_int(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_uint(struct weston_config_section *section,
 			       const char *key,
@@ -210,6 +225,9 @@ weston_config_section_get_uint(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_color(struct weston_config_section *section,
 				const char *key,
@@ -247,6 +265,9 @@ weston_config_section_get_color(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_double(struct weston_config_section *section,
 				 const char *key,
@@ -272,6 +293,9 @@ weston_config_section_get_double(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_string(struct weston_config_section *section,
 				 const char *key,
@@ -294,6 +318,9 @@ weston_config_section_get_string(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_section_get_bool(struct weston_config_section *section,
 			       const char *key,
@@ -321,6 +348,9 @@ weston_config_section_get_bool(struct weston_config_section *section,
 	return 0;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT const char *
 weston_config_get_name_from_env(void)
 {
@@ -447,6 +477,9 @@ weston_config_parse_fp(FILE *file)
 	return config;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT struct weston_config *
 weston_config_parse(const char *name)
 {
@@ -498,6 +531,9 @@ weston_config_get_full_path(struct weston_config *config)
 	return config == NULL ? NULL : config->path;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT int
 weston_config_next_section(struct weston_config *config,
 			   struct weston_config_section **section,
@@ -521,6 +557,9 @@ weston_config_next_section(struct weston_config *config,
 	return 1;
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT void
 weston_config_destroy(struct weston_config *config)
 {
@@ -543,6 +582,9 @@ weston_config_destroy(struct weston_config *config)
 	free(config);
 }
 
+/**
+ * \ingroup weston-config
+ */
 WL_EXPORT uint32_t
 weston_config_get_binding_modifier(struct weston_config *config,
 				   uint32_t default_mod)