Skip to content

Commit 72cf719

Browse files
crasbecrasbe
committed
boards/nucleo*: create dedicated variant doc.md files
1 parent 5afe64e commit 72cf719

File tree

7 files changed

+71
-17
lines changed

7 files changed

+71
-17
lines changed

‎boards/common/nucleo144/doc.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
@defgroup boards_common_nucleo144 STM32 Nucleo-144
2+
@ingroup boards
3+
@brief Support for STM32 Nucleo-144 boards
4+
5+
## Flashing the Board
6+
7+
A detailed description about the flashing process can be found on the
8+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
9+
10+
## Accessing the RIOT shell
11+
12+
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
13+
that is featured on every Nucleo board. The USART used for this connection
14+
varies between the different Nucleo variants, so you have to consult the
15+
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
16+
17+
The default baud rate is 115200, 8N1.

‎boards/common/nucleo144/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
#pragma once
99

1010
/**
11-
* @defgroup boards_common_nucleo144 STM32 Nucleo-144
12-
* @ingroup boards
13-
* @brief Support for STM32 Nucleo-144 boards
11+
* @ingroup boards_common_nucleo144
1412
* @{
1513
*
1614
* @file

‎boards/common/nucleo32/doc.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
@defgroup boards_common_nucleo32 STM32 Nucleo-32
2+
@ingroup boards
3+
@brief Support for STM32 Nucleo-32 boards
4+
5+
## Flashing the Board
6+
7+
A detailed description about the flashing process can be found on the
8+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
9+
10+
## Accessing the RIOT shell
11+
12+
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
13+
that is featured on every Nucleo board. The USART used for this connection
14+
varies between the different Nucleo variants, so you have to consult the
15+
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
16+
17+
The default baud rate is 115200, 8N1.

‎boards/common/nucleo32/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_common_nucleo32 STM32 Nucleo-32
10-
* @ingroup boards
11-
* @brief Support for STM32 Nucleo-32 boards
9+
* @ingroup boards_common_nucleo32
1210
* @{
1311
*
1412
* @file

‎boards/common/nucleo64/doc.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
@defgroup boards_common_nucleo64 STM32 Nucleo-64
2+
@ingroup boards
3+
@brief Support for STM32 Nucleo-64 Boards
4+
5+
## Using LED0 and SPI at once
6+
7+
Due to a pin conflict on Nucleo64 boards, you can not use
8+
the SPI peripheral and LED0 at the same time.
9+
A warning will be shown during compile time:
10+
```
11+
Warning: Using periph_spi on Nucleo64 boards will disable LED0 due to pin conflicts.
12+
```
13+
14+
## Flashing the Board
15+
16+
A detailed description about the flashing process can be found on the
17+
[guides page](https://guide.riot-os.org/board_specific/stm32/).
18+
19+
## Accessing the RIOT shell
20+
21+
The default RIOT OS shell access utilizes the ST-Link VCP (Virtual COM Port)
22+
that is featured on every Nucleo board. The USART used for this connection
23+
varies between the different Nucleo variants, so you have to consult the
24+
`nucleo-xxxxx/include/periph_conf.h` header file for more information.
25+
26+
The default baud rate is 115200, 8N1.

‎boards/common/nucleo64/include/board.h‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
#pragma once
77

88
/**
9-
* @defgroup boards_common_nucleo64 STM32 Nucleo-64
10-
* @ingroup boards
11-
* @brief Support for STM32 Nucleo-64 boards
9+
* @ingroup boards_common_nucleo64
1210
* @{
1311
*
1412
* @file

‎dist/tools/doccheck/exclude_simple‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4699,8 +4699,8 @@ warning: Member MODULE_PIN_P6 (macro definition) of file board_module.h is not d
46994699
warning: Member MODULE_PIN_P7 (macro definition) of file board_module.h is not documented.
47004700
warning: Member MODULE_PIN_P8 (macro definition) of file board_module.h is not documented.
47014701
warning: Member MODULE_PIN_P9 (macro definition) of file board_module.h is not documented.
4702-
warning: Member motor_driver_config[] (variable) of group boards_common_nucleo64 is not documented.
4703-
warning: Member MOTOR_DRIVER_NUMOF (macro definition) of group boards_common_nucleo64 is not documented.
4702+
warning: Member motor_driver_config[] (variable) of file board.h is not documented.
4703+
warning: Member MOTOR_DRIVER_NUMOF (macro definition) of file board.h is not documented.
47044704
warning: Member MPL3115A2_CTRL_REG1_ALT (macro definition) of file mpl3115a2_reg.h is not documented.
47054705
warning: Member MPL3115A2_CTRL_REG1_OS_MASK (macro definition) of file mpl3115a2_reg.h is not documented.
47064706
warning: Member MPL3115A2_CTRL_REG1_OS_SHIFT (macro definition) of file mpl3115a2_reg.h is not documented.
@@ -4871,17 +4871,17 @@ warning: Member MRF24J40_PACON2_TXONTS1 (macro definition) of file mrf24j40_regi
48714871
warning: Member MRF24J40_PACON2_TXONTS2 (macro definition) of file mrf24j40_registers.h is not documented.
48724872
warning: Member MRF24J40_PACON2_TXONTS3 (macro definition) of file mrf24j40_registers.h is not documented.
48734873
warning: Member MRF24J40_PARAM_CS (macro definition) of file mrf24j40_params.h is not documented.
4874-
warning: Member MRF24J40_PARAM_CS (macro definition) of group boards_common_nucleo64 is not documented.
4874+
warning: Member MRF24J40_PARAM_CS (macro definition) of file board.h is not documented.
48754875
warning: Member MRF24J40_PARAM_INT (macro definition) of file mrf24j40_params.h is not documented.
4876-
warning: Member MRF24J40_PARAM_INT (macro definition) of group boards_common_nucleo64 is not documented.
4876+
warning: Member MRF24J40_PARAM_INT (macro definition) of file board.h is not documented.
48774877
warning: Member MRF24J40_PARAM_RESET (macro definition) of file mrf24j40_params.h is not documented.
4878-
warning: Member MRF24J40_PARAM_RESET (macro definition) of group boards_common_nucleo64 is not documented.
4878+
warning: Member MRF24J40_PARAM_RESET (macro definition) of file board.h is not documented.
48794879
warning: Member MRF24J40_PARAMS (macro definition) of file mrf24j40_params.h is not documented.
4880-
warning: Member MRF24J40_PARAMS (macro definition) of group boards_common_nucleo64 is not documented.
4880+
warning: Member MRF24J40_PARAMS (macro definition) of file board.h is not documented.
48814881
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of file mrf24j40_params.h is not documented.
4882-
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of group boards_common_nucleo64 is not documented.
4882+
warning: Member MRF24J40_PARAM_SPI_CLK (macro definition) of file board.h is not documented.
48834883
warning: Member MRF24J40_PARAM_SPI (macro definition) of file mrf24j40_params.h is not documented.
4884-
warning: Member MRF24J40_PARAM_SPI (macro definition) of group boards_common_nucleo64 is not documented.
4884+
warning: Member MRF24J40_PARAM_SPI (macro definition) of file board.h is not documented.
48854885
warning: Member MRF24J40_REG_ACKTMOUT (macro definition) of file mrf24j40_registers.h is not documented.
48864886
warning: Member MRF24J40_REG_ASSOEADR0 (macro definition) of file mrf24j40_registers.h is not documented.
48874887
warning: Member MRF24J40_REG_ASSOEADR1 (macro definition) of file mrf24j40_registers.h is not documented.

0 commit comments

Comments
 (0)