Add licenses, docbook, general cleanup

components/esp32/brownout.c

@@ -24,7 +24,7 @@
 
 #if CONFIG_BROWNOUT_DET
 /*
-This file ins included in esp-idf, but the menuconfig option for this is disabled because a silicon bug
+This file is included in esp-idf, but the menuconfig option for this is disabled because a silicon bug
 prohibits the brownout detector from functioning correctly on the ESP32.
 */
 

components/esp32/include/esp_brownout.h

@@ -1,5 +1,20 @@
-#ifndef BROWNOUT_H
-#define BROWNOUT_H
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+
+#ifndef __ESP_BROWNOUT_H
+#define __ESP_BROWNOUT_H
 
 void esp_brownout_init();
 

components/esp32/include/esp_int_wdt.h

@@ -1,6 +1,46 @@
-#ifndef INT_WDT_H
-#define INT_WDT_H
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
 
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef __ESP_INT_WDT_H
+#define __ESP_INT_WDT_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** @addtogroup Watchdog_APIs
+  * @{
+  */
+
+/**
+  * @brief  Initialize the interrupt watchdog. This is called in the init code, no need to 
+  *         call it explicitly.
+  *
+  * @param  null
+  *
+  * @return null
+  */
 void int_wdt_init();
 
+
+/**
+  * @}
+  */
+
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif

components/esp32/include/esp_task_wdt.h

@@ -1,8 +1,73 @@
-#ifndef TASK_WDT_H
-#define TASK_WDT_H
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
 
-void task_wdt_feed();
-void task_wdt_delete();
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef __ESP_TASK_WDT_H
+#define __ESP_TASK_WDT_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/** \defgroup Watchdog_APIs Watchdog APIs
+  * @brief Watchdog APIs
+  */
+
+/** @addtogroup Watchdog_APIs
+  * @{
+  */
+
+/**
+  * @brief  Initialize the task watchdog. This is called in the init code, no need to 
+  *         call it explicitly.
+  *
+  * @param  null
+  *
+  * @return null
+  */
 void task_wdt_init();
 
+/**
+  * @brief  Feed the watchdog. After the first feeding session, the watchdog will expect the calling
+  *         task to keep feeding the watchdog until task_wdt_delete() is called.
+  *
+  * @param  null
+  *
+  * @return null
+  */
+
+void task_wdt_feed();
+
+
+/**
+  * @brief  Delete the watchdog for the current task.
+  *
+  * @param  null
+  *
+  * @return null
+  */
+void task_wdt_delete();
+
+/**
+  * @}
+  */
+
+
+#ifdef __cplusplus
+}
+#endif
+
+
+
 #endif