1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Commit Graph

135 Commits

Author SHA1 Message Date
Leandro Lanzieri
4eb58d74b5
drivers/ft5x06: allow multiple device types 2022-01-21 13:13:09 +01:00
chrysn
13036c1bc4 net/iee802154 doc: Add overview / introduction documentation
The module previously called net_ieee802154 is renamed to capture that
it is about interacting the frames and headers, and moved "into" the new
topic in the documentation tree.

Exceptions for undocumented headers are updated.
2022-01-16 11:29:32 +01:00
5bbab90f57
tools/doccheck: extend exclude patterns 2022-01-09 16:43:35 +01:00
86af5b5832
tools/doccheck: extend exclude patterns for b-u585i-iot02a 2021-12-23 11:04:42 +01:00
dba0dab1b1
doccheck: add stm32f746g-disco warning to exclude patterns 2021-11-16 10:51:48 +01:00
Francisco
72abac66f1
Merge pull request #17183 from fjmolinas/pr_stm32wl_adc
cpu/stm32/wl: initial periph_adc implementation
2021-11-15 19:06:24 +01:00
Francisco Molina
6346fc8613 boards/lora-e5-dev: map a4, a5 analog inputs 2021-11-15 17:07:21 +01:00
2f6b7bc651
Merge pull request #17082 from kaspar030/add_doxy_pattern_script
dist/tools/doccheck: add create_pattern.sh
2021-11-15 15:35:59 +01:00
Francisco Molina
15b22f83c1 dist/tools/doccheck/exclude_patterns: add lora-e5-dev 2021-11-08 20:01:52 +01:00
Francisco Molina
9a050dc2e8 dist/tools/doccheck/exclude_patterns: add new warnings 2021-11-02 11:48:50 +01:00
3cb3976ae0 dist/tools/doccheck: add create_pattern.sh 2021-10-29 12:21:39 +02:00
f27fce0eed doccheck: add nucleo-g07xrb group members to exclude_patterns 2021-10-29 10:49:38 +02:00
Francisco Molina
2552c6941e treewide: remove mentions of 'fox' BOARD 2021-10-20 13:53:26 +02:00
Jean-Pierre De Jesus DIAZ
70b074ff8f boards/adafruit-clue: fix doxygen warnings
Signed-off-by: Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
2021-09-14 11:16:50 +02:00
Jean-Pierre De Jesus DIAZ
7fe67ea285 dist/tools/doccheck: generate exclude_patterns using C.UTF-8
Signed-off-by: Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
2021-09-14 10:21:35 +02:00
Jean-Pierre De Jesus DIAZ
6f8803e34f dist/tools/doccheck: update exclude_patterns
Signed-off-by: Jean-Pierre De Jesus DIAZ <me@jeandudey.tech>
2021-09-11 12:45:15 +02:00
Martine Lenders
8e1dd16d37
doccheck: fix or suppress shellcheck warnings 2021-08-31 19:20:37 +02:00
Martine Lenders
acdcaf16a5
dist/tools/doccheck: add exclude file for warnings and use it
This is purely to finally unblock RIOT-OS/riotdocker#104, but may also
be useful to add future exclude patterns.

Exclude file was generated using

```sh
make doc 2> dist/tools/doccheck/exclude_patterns_base
grep "^${PWD}" dist/tools/doccheck/exclude_patterns_base | \
    sed -E -e "s#^${PWD}/(.*:)([0-9]+): #\1DIGITS_MAGIC: #" \
           -e 's/[]\\.$*{}|+?()[^-]/\\&/g' \
           -e 's/:DIGITS_MAGIC:/:[0-9]+:/' \
        > dist/tools/doccheck/exclude_patterns
rm dist/tools/doccheck/exclude_patterns_base
```
2021-08-31 19:20:37 +02:00
Martine Lenders
9ee568e319
dist/tools/doccheck: annotate errors in Github Action 2021-01-11 15:57:14 +01:00
Martine Lenders
db81377af7
dist/tools/doccheck: only exit after when every check ran
Doxygen takes an eternity to finish anyways, so it does not hurt to not
early exit for the group checks.
2021-01-11 15:27:21 +01:00
5837075150
tools/doccheck: optimize display of undefined groups
The printed variable is not computed if no undefined group is found
2019-08-07 10:33:03 +02:00
1876619bf9
tools/doccheck: add check for multiple group definition 2019-08-07 10:33:03 +02:00
Juan Carrano
ae4cecd14c tools/doccheck: Detect when make doc fails to run.
The previous doccheck would give a false negative when doxygen does
not even run (for example, because of misconfiguration).

Also, when doxygen fails to run, print the full output.
2018-11-22 16:51:07 +01:00
Martine Lenders
6f8fd1d6df doccheck: exclude dist/tools directory from group check 2018-10-11 15:16:09 +02:00
Cenk Gündoğan
2706264908
Merge pull request #9292 from smlng/pr/tools/doccheck
tools/doccheck: adapt script to run on macOS
2018-06-12 10:28:43 +02:00
00828bb62d dist/tools/doccheck: enable group check in CI 2018-06-11 19:12:02 +02:00
smlng
cba319079c tools/doccheck: adapt script to run on macOS 2018-06-11 09:50:32 +02:00
2f21e16915 dist/tools/doccheck: add check for undefined groups 2018-06-07 19:29:38 +02:00
Martine Lenders
90d2060188
docheck: make doccheck executable from any directory
The doccheck script reports reports a false positive when executed from
any directory but `RIOTBASE`. With this fix, `make doc` changes into
the currently unused `RIOTBASE` variable.

This is an alternative approach to #7217, which removes this variable,
but keeps the false positive aspect of the script untouched.
2017-12-07 11:01:49 +01:00
Martine Lenders
0f2fa7883c doccheck: actually show warning, not just file 2017-05-17 13:01:13 +02:00
Oleg Hahm
44604a9ed5 tools: make doccheck check all files 2017-03-10 14:56:48 +01:00
Joakim Gebart
9cd8da3e72 dist/tools/doccheck/check.sh: trailing space fix 2015-05-09 08:57:41 +02:00
Oleg Hahm
bb7453dc70 doccheck: grep for all lines with a warning 2014-12-11 16:35:41 +01:00
Oleg Hahm
83da4a8738 travis: added doxygen check script to travis config 2014-12-03 11:10:25 +01:00
Oleg Hahm
f97f9ff826 travis: check for doxygen warnings
This introduces a script that will check for doxygen warnings in newly
committed or edited files.
2014-12-03 11:10:12 +01:00