Document the autodetector

Change-Id: I44da738539a56fd47f43513c4649d62718790042
Signed-off-by: Michal Bloch <m.bloch@samsung.com>

diff --git a/src/shared/logconfig.c b/src/shared/logconfig.c
index adf4e18..378f3af 100644 (file)
--- a/src/shared/logconfig.c
+++ b/src/shared/logconfig.c
@@ -74,6 +74,17 @@ const char *log_config_get(const struct log_config *config, const char *key)
        return NULL;
 }
 
+/**
+ * @brief Autodetect backend
+ * @details Picks the backend, autodetecting it if not explicitly specified.
+ *          Note that this is not just a convenience feature - Tizen IoT images
+ *          mix and match arbitrary kernel images (on which the presence of
+ *          Android Logger devices depends) and rootfs images (which contain
+ *          the DLog config files). This means that the config file cannot
+ *          be prepared for any single kernel and has to support both.
+ * @param[in] conf The config struct
+ * @return The backend string
+ */
 const char *log_config_claim_backend(struct log_config *config)
 {
        const char *backend = log_config_get((const struct log_config *)config, "backend");