Martine Lenders
cc0c8a1947
doc: introduce memtitle class
...
Our doc builder at doc.riot-os.org was updated and now the documentation
looks weird (see http://doc.riot-os.org/group__core__msg.html#gad1353dec9af776d4caf5f4e00cec112e
e.g.). This fixes that.
5 years ago
Raul Fuentes
1c0653f383
Doxygen: Completed line for Makefile.base
5 years ago
Martine Lenders
cac6da3fb7
doc: fix "Creating an application" page
5 years ago
Martine Lenders
0469dec71e
doc: add release notes to doxygen documentation
...
Provides a script to generate a doxygen page from the
`release-notes.txt` and includes it to the doxygen build.
5 years ago
Martine Lenders
b092179787
doc: utilize smartmenus
5 years ago
Martine Lenders
c00a89fd9e
doc: fix spacing in parameter description
...
Fixes #6953
5 years ago
Martine Lenders
1724b97b23
doc: add build capacities for LESS
5 years ago
Martine Lenders
75eef79c9e
doc: add favicon
5 years ago
Martine Lenders
8ea20ea505
doc: Doxygen beautification
5 years ago
Martine Lenders
4dad2baae7
doc: add note about security@riot-os.org
5 years ago
Martine Lenders
29842bb5e4
netdev2: rename to netdev and remove `gnrc_netdev`
...
With some minor hand-edits I used the following chain of commands:
```sh
git rm sys/include/net/gnrc/netdev.h
git grep --name-only -i netdev2 | \
xargs sed -i -e 's/^\(NETDEV\)2\(.*\)\( [("]\)/\1\2 \3/g' \
-e 's/\(netdev\)2\(.*\)\( \/\*\*<\)/\1\2 \3/I' \
-e 's/\(netdev\)2/\1/gI'
git add -p
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
grep "netdev2" | xargs -I'{}' dirname '{}' | uniq | \
grep "netdev2" | while read dir; do
new_dir="$(echo "$dir" | sed "s/netdev2/netdev/g")"
git mv -f "$dir" "$new_dir"
done
git commit --amend
git ls-tree --full-tree -r HEAD --name-only | \
grep "netdev2" | while read file; do
new_file="$(echo "$file" | sed "s/netdev2/netdev/g")"
git mv -f "$file" "$new_file"
done
git commit --amend
git grep --name-only "\<drivers_netdev_netdev\>" | \
xargs sed -i "s/\<drivers_netdev_netdev\>/drivers_netdev_api/g"
git add -p
git commit --amend
```
5 years ago
Oleg Hahm
350a55b58f
doc: increase number of nodes for doxygen graphs
5 years ago
Oleg Hahm
28c335e8e7
doc: exclude _param files from doxygen
5 years ago
Oleg Hahm
5ff3a1c957
doc: doxygen: update exclude paths
5 years ago
Joakim Nohlgård
738876a98f
cpu/atmega_common: Improve POSIX headers
5 years ago
Hauke Petersen
e6db9587db
drivers/nrf24l01: removed doxgen warnings
...
- de-blacklisted nrf24l01p_settings.h from doxygen excludes
- fixed doc for that file
5 years ago
Hauke Petersen
fa59955eff
doc: removed CPU excludes from doxyfile
5 years ago
Alexandre Abadie
36e8fb8e56
doc/doxygen: exclude cpu/stm32l0 directory from doxygen
5 years ago
Joakim Nohlgård
bec5b57f0d
doc/doxygen: Exclude msp430-common imported newlib headers
5 years ago
Joakim Nohlgård
4bd62d241f
doc/doxygen: Sort exclude patterns
5 years ago
smlng
887f499eca
drivers/kw2xrf: adapt to new SPI interface
...
- add docu for structs, defines and functions
- exclude drivers/kw2xrf/include/overwrites.h (vendor header)
- add missing header guards
5 years ago
Joakim Nohlgård
125e3b0125
doc: Add some missing excludes
6 years ago
Joakim Nohlgård
7e8f001d43
doc: Remove doxygen_entrydb_*.tmp when cleaning
...
Doxygen 1.8.12 leaves these files behind after finishing the build.
6 years ago
Joakim Nohlgård
a3aa865541
doc: Only strip core, drivers, and sys include path prefixes
...
fixes tons of false warnings on cpu_conf.h headers in cpu
/tmp/RIOT/cpu/atmega1281/include/cpu_conf.h:12: warning: the name `/tmp/RIOT/cpu/atmega1281/include/cpu_conf.h' supplied as the second argument in the \file statement matches the following input files:
/tmp/RIOT/cpu/atmega1281/include/cpu_conf.h
Please use a more specific name by including a (larger) part of the path!
6 years ago
Oleg Hahm
cafafd5744
doc: escape hash character
6 years ago
Oleg Hahm
8a9f6a31a6
doc: replace pkg example in documentation
6 years ago
Hauke Petersen
fcb1e68732
cpu/sam0: renamed sam21_common to sam0_common
6 years ago
Martine Lenders
235375f664
native: always assert() verbosely
6 years ago
Alexandre Abadie
b50ab2f46e
cpu/stm32f4: adding support for stm32f446re cpu
6 years ago
Kees Bakker
ebeece15c7
doc: correct exclude patterns after moving CMSIS files to cpu/sam21_common
6 years ago
Vincent Dupont
537d1d015a
stm32f2: exlude vendor headers from doxygen
6 years ago
Joakim Nohlgård
6e09581def
doc: Set QUIET=YES in Doxyfile
...
(Warnings are still shown because WARNINGS=YES)
6 years ago
Ludwig Knüpfer
b87bc37b89
doc: un-exclude board's periph_conf.h in Doxygen
6 years ago
Martine Lenders
16bcffc69b
doc: add operational flow figure for netdev
6 years ago
Martine Lenders
8c52d3e364
doc: fix typo
6 years ago
Andreas Paul Pauli
bce61166ee
doc: provide include path list for riot.doxyfile
6 years ago
Oleg Hahm
8e6dc1a03f
doc: updated and clarified tapsetup usage
6 years ago
Kaspar Schleiser
d9cf871e2e
sys: random: import tinymt32 PRNG
6 years ago
Ludwig Knüpfer
79da205cd8
doc: fix trailing whitespace in Doxygen XML
6 years ago
Ludwig Knüpfer
200e60ea58
doc: disable REPEAT_BRIEF Doxgen setting
...
Details follow the brief section immediately now.
6 years ago
Ludwig Knüpfer
7c188378a9
doc: move details section to the top
...
Add a layout file for Doxygen which has the details section at the
beginning of a page as opposed to the default where the details are
somewhere in the middle.
The initial XML file was generated as specified in the Doxygen
documentation:
```
doxygen -l
```
6 years ago
Hauke Petersen
c49eb824e5
doc/riot.doxyfile: s/CPUID_ID_LEN/CPUID_LEN/
6 years ago
Martine Lenders
8a588575f3
doc: fix link to devel mailman
6 years ago
Hauke Petersen
0b1bc39fd5
doc: adapted doxygen excludes for NRF5x headers
6 years ago
Martine Lenders
b5f5f8314a
doc: add page about creating modules
7 years ago
Hauke Petersen
bed0aec61e
doc: added samd21 vendor header to doxygen excludes
7 years ago
Martine Lenders
31702f3ce8
doc: mention create-an-application page on main page
7 years ago
Martine Lenders
80829d5eba
doc: add page about creating an application
7 years ago
Martine Lenders
f285bb2349
doc: move pkg/PORTING.md and pkg/USING.md to doxygen
7 years ago
Cenk Gündoğan
9d270ad1c0
doxygen: mainpage: link to GNRC
7 years ago