]> granicus.if.org Git - esp-idf/commitdiff
Fixed confused Sphinx
authorKrzysztof <krzychb@gazeta.pl>
Sat, 29 Oct 2016 21:15:27 +0000 (23:15 +0200)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 31 Oct 2016 17:21:18 +0000 (01:21 +0800)
Sphinx failed to phrase esp_log_timestamp
reorderdering esp_log_write and esp_log_timestamp fixed this issue

components/log/include/esp_log.h
docs/api/log.rst

index 2878dc50157bcb050fea6c27812ceb58c0776a80..6716f6e10fba5c6a2a6918bb422d5b31c00f8e79 100644 (file)
@@ -29,7 +29,7 @@ extern "C" {
  */
 typedef enum {
     ESP_LOG_NONE,       /*!< No log output */
-    ESP_LOG_ERROR,      /*!<  Critical errors, software module can not recover on its own */
+    ESP_LOG_ERROR,      /*!< Critical errors, software module can not recover on its own */
     ESP_LOG_WARN,       /*!< Error conditions from which recovery measures have been taken */
     ESP_LOG_INFO,       /*!< Information messages which describe normal flow of events */
     ESP_LOG_DEBUG,      /*!< Extra information which is not necessary for normal use (values, pointers, sizes, etc). */
@@ -60,17 +60,6 @@ void esp_log_level_set(const char* tag, esp_log_level_t level);
  */
 void esp_log_set_vprintf(vprintf_like_t func);
 
-/**
- * @brief Write message into the log
- *
- * This function is not intended to be used directly. Instead, use one of
- * ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV macros.
- *
- * This function or these macros should not be used from an interrupt.
- */
-void esp_log_write(esp_log_level_t level, const char* tag, const char* format, ...) __attribute__ ((format (printf, 3, 4)));
-
-
 /**
  * @brief Function which returns timestamp to be used in log output
  *
@@ -85,6 +74,16 @@ void esp_log_write(esp_log_level_t level, const char* tag, const char* format, .
  */
 uint32_t esp_log_timestamp(void);
 
+/**
+ * @brief Write message into the log
+ *
+ * This function is not intended to be used directly. Instead, use one of
+ * ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV macros.
+ *
+ * This function or these macros should not be used from an interrupt.
+ */
+void esp_log_write(esp_log_level_t level, const char* tag, const char* format, ...) __attribute__ ((format (printf, 3, 4)));
+
 
 #if CONFIG_LOG_COLORS
 #define LOG_COLOR_BLACK   "30"
index 8e0f2d85da3e96553021b733c60bc35b1c7529fc..dc76a30470870f06031c3b32a9760bb41b5fb631 100644 (file)
@@ -13,8 +13,7 @@ Functions
 
 .. doxygenfunction:: esp_log_level_set
 .. doxygenfunction:: esp_log_set_vprintf
+.. doxygenfunction:: esp_log_timestamp
 .. doxygenfunction:: esp_log_write
 
-.. FIXME esp_log_timestamp
-