[mynewt-mcumgr] 14/25: Add doxygen comments for log_mgmt.

[cc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ccollins pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-mcumgr.git

commit 89ee0f53d87e5abd47fffc052b5d945505ab7940
Author: Christopher Collins <cc...@apache.org>
AuthorDate: Tue Jan 30 11:40:38 2018 -0800

    Add doxygen comments for log_mgmt.
---
 cmd/log_mgmt/include/log_mgmt/log_mgmt_impl.h | 72 +++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

diff --git a/cmd/log_mgmt/include/log_mgmt/log_mgmt_impl.h b/cmd/log_mgmt/include/log_mgmt/log_mgmt_impl.h
index 1890643..b3f6b12 100644
--- a/cmd/log_mgmt/include/log_mgmt/log_mgmt_impl.h
+++ b/cmd/log_mgmt/include/log_mgmt/log_mgmt_impl.h
@@ -17,6 +17,13 @@
  * under the License.
  */
 
+/**
+ * @file
+ * @brief Declares implementation-specific functions required by log
+ *        management.  The default stubs can be overridden with functions that
+ *        are compatible with the host OS.
+ */
+
 #ifndef H_LOG_MGMT_IMPL_
 #define H_LOG_MGMT_IMPL_
 
@@ -31,14 +38,79 @@ struct log_mgmt_log;
 typedef int log_mgmt_foreach_entry_fn(const struct log_mgmt_entry *entry,
                                       void *arg);
 
+/**
+ * @brief Retrieves the log at the specified index.
+ *
+ * @param idx                   The index of the log to retrieve.
+ * @param out_name              On success, the requested log gets written
+ *                                   here.
+ *
+ * @return                      0 on success;
+ *                              MGMT_ERR_ENOENT if no log with the specified
+ *                                  index exists;
+ *                              Other MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_get_log(int idx, struct log_mgmt_log *out_log);
+
+/**
+ * @brief Retrieves the name of log module at the specified index.
+ *
+ * @param idx                   The index of the log module to retrieve.
+ * @param out_name              On success, the requested module's name gets
+ *                                  written here.
+ *
+ * @return                      0 on success;
+ *                              MGMT_ERR_ENOENT if no log module with the
+ *                                  specified index exists;
+ *                              Other MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_get_module(int idx, const char **out_module_name);
+
+/**
+ * @brief Retrieves the name of log level at the specified index.
+ *
+ * @param idx                   The index of the log level to retrieve.
+ * @param out_name              On success, the requested level's name gets
+ *                                  written here.
+ *
+ * @return                      0 on success;
+ *                              MGMT_ERR_ENOENT if no log level with the
+ *                                  specified index exists;
+ *                              Other MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_get_level(int idx, const char **out_level_name);
+
+/**
+ * @brief Retrieves the index that the next log entry will use.
+ *
+ * @param out_idx               On success, the next index gets written here.
+ *
+ * @return                      0 on success; MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_get_next_idx(uint32_t *out_idx);
+
+/**
+ * @brief Applies a function to every matching entry in the specified log.
+ *
+ * @param log_name              The name of the log to operate on.
+ * @param filter                Specifies which log entries to operate on.
+ * @param cb                    The callback to apply to each log entry.
+ * @param arg                   An optional argument to pass to the callback.
+ *
+ * @return                      0 on success; MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_foreach_entry(const char *log_name,
                                 const struct log_mgmt_filter *filter,
                                 log_mgmt_foreach_entry_fn *cb,
                                 void *arg);
+
+/**
+ * @brief Clear the log with the specified name.
+ *
+ * @param log_name              The name of the log to clear.
+ *
+ * @return                      0 on success; MGMT_ERR_[...] code on failure.
+ */
 int log_mgmt_impl_clear(const char *log_name);
 
 #ifdef __cplusplus

-- 
To stop receiving notification emails like this one, please contact
ccollins@apache.org.