tests/doc: Fixed group names and docs required of some modules

Mesh4all · Jul 25, 2022 · 633b999 · 633b999
1 parent 64c84c9
commit 633b999
Show file tree

Hide file tree

Showing 37 changed files with 231 additions and 292 deletions.
diff --git a/examples/external_led/Makefile → examples/blinking/Makefile b/examples/external_led/Makefile → examples/blinking/Makefile
diff --git a/examples/external_led/README.md → examples/blinking/README.md b/examples/external_led/README.md → examples/blinking/README.md
diff --git a/examples/external_led/doc.txt → examples/blinking/doc.txt b/examples/external_led/doc.txt → examples/blinking/doc.txt
@@ -7,20 +7,20 @@
  */
 
 /**
- * @defgroup    external-led External-led blink
+ * @defgroup    examples_blinking Blinking
  * @ingroup     examples
- * @brief       This is a external led blink example to known about gpio/periph.h
+ * @brief       This is a led blink example to known about gpio/periph.h
  * @author      xkevin190 <[email protected]>
 
 \section led External Led Blink
 
-## Table of Contents {#external_led_blink_toc}
+## Table of Contents {#blinking_toc}
 
-1. [Hardware](#external_led_blink_hardware)
-2. [Getting Started](#external_led_blink_basic)
-3. [Flashing the Device](#external_led_blink_flashing)
+1. [Hardware](#blinking_hardware)
+2. [Getting Started](#blinking_basic)
+3. [Flashing the Device](#blinking_flashing)
 
-## Hardware {#external_led_blink_hardware}
+## Hardware {#blinking_hardware}
 
 This section shows, which pin is used in this example.
 
@@ -30,7 +30,7 @@ Function        | GPIOs  | Remarks |
 LED_PIN | GPIO(PA , 19)| Pin to blink control of led |
 
 </center>
-## Getting Started {#external_led_blink_basic}
+## Getting Started {#blinking_basic}
 
 To understand how to make a gpio_pin use digital Output. Import the periph/gpio.h library.
 You could use two functions to set digital output 1 or 0.
@@ -51,12 +51,12 @@ changes the value of current state. (means if is HIGH, when applied this functio
 
 another aspect to be take into account is add the xtimer and ztimer headers files, to use temporizers in our code.
 
-## Flashing {#external_led_blink_flashing}
+## Flashing {#blinking_flashing}
 
 If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal and watch the results
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-make -C examples/esp32-wroom-32/external_led flash term
+make -C examples/blinking flash term
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-[Back to table of contents](#external_led_blink_toc)
+[Back to table of contents](#blinking_toc)
  */
diff --git a/examples/external_led/main.c → examples/blinking/main.c b/examples/external_led/main.c → examples/blinking/main.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @ingroup     examples_esp32-wrover
+ * @ingroup     examples_blinking
  *
  * @file
  * @brief       this is an example of external_led_blink

diff --git a/examples/doc.txt b/examples/doc.txt
@@ -1,5 +1,5 @@
 /**
-@defgroup examples Mesh4all Examples
+@defgroup examples Sample applications running on Mesh4all-boards
 
 ## This is example-doc
 

diff --git a/examples/ds18b20/Makefile → examples/ds18/Makefile b/examples/ds18b20/Makefile → examples/ds18/Makefile
diff --git a/examples/ds18b20/README.md → examples/ds18/README.md b/examples/ds18b20/README.md → examples/ds18/README.md
diff --git a/examples/ds18b20/doc.txt → examples/ds18/doc.txt b/examples/ds18b20/doc.txt → examples/ds18/doc.txt
@@ -7,19 +7,19 @@
  */
 
 /**
- * @defgroup    ds18b20 Ds18b20
+ * @defgroup    examples_ds18 Sample application of Ds18 sensor
  * @ingroup     examples
- * @brief       ds18b20 sensor example to use with m4a-wroom board
+ * @brief       Sample application using a ds18 temperature sensor
  * @author      Eduardo Azócar <[email protected]>
 
-\section ds18b20
-## Table of Contents {#m4a_ds18b20_toc}
+\section ds18
+## Table of Contents {#m4a_ds18_toc}
 
-1. [Hardware](#m4a_ds18b20_hardware)
-2. [Basic and Default configuration](#m4a_ds18b20_basic_conf)
-3. [Flashing the Device](#m4a_ds18b20_flashing)
+1. [Hardware](#m4a_ds18_hardware)
+2. [Basic and Default configuration](#m4a_ds18_basic_conf)
+3. [Flashing the Device](#m4a_ds18_flashing)
 
-## Hardware {#m4a_ds18b20_hardware}
+## Hardware {#m4a_ds18_hardware}
 
 This section shows, which pin is used to receive the sensor data.
 
@@ -30,16 +30,16 @@ DS18B20_PIN | GPIO_PIN(PA, 5)| This is data pin to receive the reads.
 
 </center>
 
-You could change the ds18b20 params to get another gpio controller.
+You could change the ds18 params to get another gpio controller.
 
-## Basic and Default configuration {#m4a_ds18b20_basic_conf}
+## Basic and Default configuration {#m4a_ds18_basic_conf}
 
-## Flashing {#m4a_ds18b20_flashing}
+## Flashing {#m4a_ds18_flashing}
 
 If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal and watch the results
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-make -C examples/esp32-wroom-32/test_ds18b20 flash term
+make -C examples/ds18 flash term
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-[Back to table of contents](#m4a_ds18b20_toc)
+[Back to table of contents](#m4a_ds18_toc)
  */
diff --git a/examples/ds18b20/main.c → examples/ds18/main.c b/examples/ds18b20/main.c → examples/ds18/main.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @ingroup     ds18b20
+ * @ingroup     examples_ds18
  *
  * @brief       This is a example to understand how tu works the ds18b20
  *

diff --git a/examples/mesh4all_rpl_dag/Makefile b/examples/mesh4all_rpl_dag/Makefile
@@ -30,7 +30,6 @@ USEMODULE += ps
 USEMODULE += rpl_protocol
 USEMODULE += radio
 USEMODULE += gnrc_icmpv6_echo
-USEMODULE += at_client
 
 EXTERNAL_MODULE_DIRS += $(CURDIR)/../../firmware/peripherals
 EXTERNAL_MODULE_DIRS += $(CURDIR)/../../firmware/network

diff --git a/examples/mesh4all_rpl_dag/doc.txt b/examples/mesh4all_rpl_dag/doc.txt
@@ -0,0 +1,63 @@
+/*
+ * Copyright (C) 2022 Mesh4all <mesh4all.org>
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @defgroup    examples_rpl_dag Application to run a Rpl DAG node
+ * @ingroup     examples
+ * @brief       This is an example of a node in DAG mode under RPL protocol
+ * @author      eduazocar <[email protected]>
+
+\section sect1_RPL_dag RPL DAG
+
+## Table of Contents {#rpl_dag_toc}
+
+1. [Requirements](#rpl_dag_requirements)
+2. [Flashing the Device](#rpl_dag_flashing)
+3. [Getting Started](#rpl_dag_basic)
+
+
+## Requirements {#rpl_dag_requirements}
+
+TO run RPL protocol you need a board with radio module incorporated. because
+rpl runs to all Zigbee and IEEE802.15.4 devices.
+- Use 2 radio devices to stablish connections.
+- the second board must has the `mesh4all_rpl_dodag` example flashed
+
+## Build and flashing {#rpl_dag_flashing}
+Starts flashing the board and see the building process to be completed.
+```
+make -C examples/mesh4all_rpl_dag flash term
+```
+
+## Getting Started {#rpl_dag_basic}
+
+First start building and flashing this example in a m4a-24g Board. (if you have connected the secondary board
+running in `DODAG` mode, disconnect it, until to last step).
+The DAG mode in rpl is a passive node that should receive an ipv6 address when it's connected
+in the radio network. So when your run `ifconfig` command of the shell. you could see that
+you don´t has an ipv6 global address until the secondary board it's active in rpl `DODAG` mode.
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
+2022-07-21 12:41:39,960 # ifconfig
+2022-07-21 12:41:39,967 # Iface  4  HWaddr: 48:FC  Channel: 11  Page: 0  NID: 0x23  PHY: O-QPSK
+2022-07-21 12:41:39,968 #
+2022-07-21 12:41:39,972 #           Long HWaddr: 00:04:25:19:18:01:C8:FC
+2022-07-21 12:41:39,980 #            TX-Power: 0dBm  State: IDLE  max. Retrans.: 3  CSMA Retries: 4
+2022-07-21 12:41:39,987 #           AUTOACK  ACK_REQ  CSMA  L2-PDU:102  MTU:1280  HL:64  RTR
+2022-07-21 12:41:39,989 #           6LO  IPHC
+2022-07-21 12:41:39,992 #           Source address length: 8
+2022-07-21 12:41:39,995 #           Link type: wireless
+2022-07-21 12:41:40,001 #           inet6 addr: fe80::204:2519:1801:c8fc  scope: link  VAL
+2022-07-21 12:41:40,003 #           inet6 group: ff02::2
+2022-07-21 12:41:40,006 #           inet6 group: ff02::1
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Now, connect your DODAG board and see how the device will be inside the radio network
+
+[Back to table of contents](#rpl_dag_toc)
+ */
diff --git a/examples/moisture_sensor_hw390/doc.txt b/examples/moisture_sensor_hw390/doc.txt
@@ -7,7 +7,7 @@
  */
 
 /**
- * @defgroup    moisture_sensor_example  Analog capacitive moisture sensor
+ * @defgroup    examples_moisture_sensor  Sample Application using an Analog capacitive moisture sensor
  * @ingroup     examples
  * @brief       Example dedicated to use the analog soil moisture sensor
  * @author      xkevin190 <[email protected]>

diff --git a/examples/moisture_sensor_hw390/main.c b/examples/moisture_sensor_hw390/main.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @ingroup     moisture_sensor
+ * @ingroup     examples_moisture_sensor
  *
  * @file
  * @brief       Moisture sensor test

diff --git a/examples/slipdev/doc.txt b/examples/slipdev/doc.txt
@@ -7,7 +7,7 @@
  */
 
 /**
- @defgroup    slipdev Slipdev
+ @defgroup    examples_slipdev Sample Application to provide a internet via UART (SLIP)
  @ingroup     examples
  @brief       Slipdev example to use with m4a-wroom board
 
@@ -70,7 +70,7 @@ USEMODULE += netstats_ipv6
 If you want to upload the example to your board, needs to compile first, additional to this you could initialize the terminal to
 open directly the shell and make a ping or check de interface
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-make -C examples/esp32-wroom-32/slipdev flash term
+make -C examples/slipdev flash term
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 [Back to table of contents](#m4a_slipdev_toc)

diff --git a/examples/slipdev/main.c b/examples/slipdev/main.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @ingroup     slipdev
+ * @ingroup     examples_slipdev
  *
  * @brief       A basic demo how works the slipdev
  *

diff --git a/examples/system_example/readme.md → examples/system_example/README.md b/examples/system_example/readme.md → examples/system_example/README.md
diff --git a/examples/uart_hc-06/Makefile b/examples/uart_hc-06/Makefile
diff --git a/examples/uart_hc-06/README.md b/examples/uart_hc-06/README.md
diff --git a/examples/uart_hc-06/doc.txt b/examples/uart_hc-06/doc.txt
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,7 +15,7 @@ @@
      */
     /**
-     * @ingroup     examples_esp32-wrover
+     * @ingroup     examples_blinking
      *
      * @file
      * @brief       this is an example of external_led_blink
@@ Expand Down @@