Skip to content

doc: doc.txt -> doc.md #21255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 3, 2025
Merged

doc: doc.txt -> doc.md #21255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55fb450
doc: doc.txt -> doc.md
kfessel Feb 28, 2025
9a4024f
dist/doccheck: include doc.md for defgoup check
kfessel Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions boards/stm32f469i-disco/doc.txt → boards/stm32f469i-disco/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
/**
@defgroup boards_stm32f469i-disco STM32F469I-DISCO
@ingroup boards
@brief Support for the STM32F469I-DISCO board
Expand Down Expand Up @@ -116,6 +115,3 @@ make BOARD=stm32f469i-disco PROGRAMMER=cpy2remed flash
s
could be found on [this STM webpage](https://www.st.com/en/development-tools/sts
w-link007.html).


*/
9 changes: 3 additions & 6 deletions boards/stm32l496g-disco/doc.txt → boards/stm32l496g-disco/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/**
* @defgroup boards_stm32l496g-disco STM32L496G-DISCO
* @ingroup boards
* @brief Support for the STM32L496G-DISCO board.
@defgroup boards_stm32l496g-disco STM32L496G-DISCO
@ingroup boards
@brief Support for the STM32L496G-DISCO board.

## Overview

Expand Down Expand Up @@ -163,5 +162,3 @@ make BOARD=stm32l496g-disco debug
For using the STM32L496G-DISCO board we recommend the usage of the
[GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
toolchain.

*/
4 changes: 2 additions & 2 deletions dist/tools/doccheck/check.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
export DOCUMENTATION_FORMAT=check
fi

. "${RIOTBASE}"/dist/tools/ci/github_annotate.sh

Check warning on line 23 in dist/tools/doccheck/check.sh

View workflow job for this annotation

GitHub Actions / static-tests 

Not following: ./dist/tools/ci/github_annotate.sh was not specified as input (see shellcheck -x). [SC1091]

github_annotate_setup

Expand Down Expand Up @@ -73,8 +73,8 @@

# Check groups are correctly defined (e.g. no undefined groups and no group
# defined multiple times)
ALL_RAW_DEFGROUP=$(git grep -n @defgroup -- '*.h' '*.hpp' '*.txt' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_INGROUP=$(git grep -n '@ingroup' -- '*.h' '*.hpp' '*.txt' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_DEFGROUP=$(git grep -n @defgroup -- '*.h' '*.hpp' '*.txt' '*/doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_INGROUP=$(git grep -n '@ingroup' -- '*.h' '*.hpp' '*.txt' '*/doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
DEFINED_GROUPS=$(echo "${ALL_RAW_DEFGROUP}" | \
grep -oE '@defgroup[ ]+[^ ]+' | \
grep -oE '[^ ]+$' | \
Expand Down
1 change: 1 addition & 0 deletions doc/doxygen/riot.doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,6 +927,7 @@ INPUT_ENCODING = UTF-8
# *.ucf, *.qsf and *.ice.

FILE_PATTERNS = *.txt \
doc.md \
*.h \
*.h.in \
*.hpp
Expand Down