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

203 Commits

Author SHA1 Message Date
Martine Lenders
c00a89fd9e
doc: fix spacing in parameter description
Fixes #6953
2017-04-24 13:51:43 +02:00
Martine Lenders
d076d855c5 Merge pull request #6908 from miri64/doc/enh/less-conf
doc: add build capacities for LESS
2017-04-18 15:29:03 +02:00
Martine Lenders
1724b97b23 doc: add build capacities for LESS 2017-04-18 13:23:34 +02:00
Martine Lenders
75eef79c9e doc: add favicon 2017-04-14 03:00:47 +02:00
Martine Lenders
8ea20ea505 doc: Doxygen beautification 2017-04-13 16:41:52 +02:00
Martine Lenders
4dad2baae7 doc: add note about security@riot-os.org 2017-04-05 12:00:36 +02:00
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
```
2017-03-15 09:31:20 +01:00
Peter Kietzmann
db6bf02168 Merge pull request #6711 from haukepetersen/opt_doc_nrf24
drivers/nrf24l01: removed doxgen warnings
2017-03-13 23:39:48 +01:00
Oleg Hahm
350a55b58f doc: increase number of nodes for doxygen graphs 2017-03-10 14:56:48 +01:00
Oleg Hahm
28c335e8e7 doc: exclude _param files from doxygen 2017-03-10 14:56:48 +01:00
Oleg Hahm
5ff3a1c957 doc: doxygen: update exclude paths 2017-03-10 14:56:48 +01:00
Joakim Nohlgård
738876a98f cpu/atmega_common: Improve POSIX headers 2017-03-07 17:59:57 +01:00
Hauke Petersen
e6db9587db drivers/nrf24l01: removed doxgen warnings
- de-blacklisted nrf24l01p_settings.h from doxygen excludes
- fixed doc for that file
2017-03-07 12:19:43 +01:00
Hauke Petersen
fa59955eff doc: removed CPU excludes from doxyfile 2017-03-07 08:55:04 +01:00
36e8fb8e56 doc/doxygen: exclude cpu/stm32l0 directory from doxygen 2017-02-24 16:12:01 +01:00
Joakim Nohlgård
bec5b57f0d doc/doxygen: Exclude msp430-common imported newlib headers 2017-02-08 16:23:50 +01:00
Joakim Nohlgård
4bd62d241f doc/doxygen: Sort exclude patterns 2017-02-08 16:10:12 +01:00
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
2017-02-07 15:08:05 +01:00
Oleg Hahm
5578d57387 Merge pull request #6395 from gebart/pr/doxygen-strip-include-fix
doc: Doxygen strip include fix
2017-01-20 09:14:17 +01:00
Oleg Hahm
32ef8f8351 Merge pull request #6359 from OlegHahm/pkg_openwsn_remove
pkg: remove OpenWSN
2017-01-18 22:25:33 +01:00
Joakim Nohlgård
125e3b0125 doc: Add some missing excludes 2017-01-17 14:55:32 +01:00
Joakim Nohlgård
7e8f001d43 doc: Remove doxygen_entrydb_*.tmp when cleaning
Doxygen 1.8.12 leaves these files behind after finishing the build.
2017-01-17 14:54:45 +01:00
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!
2017-01-17 14:53:48 +01:00
Oleg Hahm
cafafd5744 doc: escape hash character 2017-01-16 18:04:04 +01:00
Oleg Hahm
8a9f6a31a6 doc: replace pkg example in documentation 2017-01-14 15:20:51 +01:00
Hauke Petersen
fcb1e68732 cpu/sam0: renamed sam21_common to sam0_common 2016-12-15 11:47:03 +01:00
Martine Lenders
235375f664 native: always assert() verbosely 2016-11-29 19:28:23 +01:00
b50ab2f46e cpu/stm32f4: adding support for stm32f446re cpu 2016-09-28 17:00:56 +02:00
Kees Bakker
ebeece15c7 doc: correct exclude patterns after moving CMSIS files to cpu/sam21_common 2016-09-21 20:34:22 +02:00
26e4004de4 Merge pull request #5397 from OTAkeys/pr/stm32f2xx
cpu: add stm32f2xx family support (based on #4497)
2016-08-31 21:14:37 +02:00
Martine Lenders
ebbfb8d9f1 Merge pull request #5739 from gebart/pr/doxygen-quiet
doc: Set QUIET=YES in Doxyfile
2016-08-30 23:21:41 +02:00
Vincent Dupont
537d1d015a stm32f2: exlude vendor headers from doxygen 2016-08-25 09:29:44 +02:00
Joakim Nohlgård
6e09581def doc: Set QUIET=YES in Doxyfile
(Warnings are still shown because WARNINGS=YES)
2016-08-09 12:04:07 +02:00
Ludwig Knüpfer
b87bc37b89 doc: un-exclude board's periph_conf.h in Doxygen 2016-07-30 09:07:08 +02:00
Martine Lenders
16bcffc69b doc: add operational flow figure for netdev 2016-06-15 23:26:22 +02:00
Martine Lenders
8c52d3e364 doc: fix typo 2016-04-08 16:08:40 +02:00
Andreas Paul Pauli
bce61166ee doc: provide include path list for riot.doxyfile 2016-03-23 23:01:46 +01:00
Oleg Hahm
8e6dc1a03f doc: updated and clarified tapsetup usage 2016-03-10 17:40:22 +01:00
d9cf871e2e sys: random: import tinymt32 PRNG 2016-02-29 12:05:31 +01:00
Ludwig Knüpfer
79da205cd8 doc: fix trailing whitespace in Doxygen XML 2016-02-21 18:58:02 +01:00
Ludwig Knüpfer
200e60ea58 doc: disable REPEAT_BRIEF Doxgen setting
Details follow the brief section immediately now.
2016-02-21 18:52:31 +01:00
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
```
2016-02-21 18:33:21 +01:00
Hauke Petersen
c49eb824e5 doc/riot.doxyfile: s/CPUID_ID_LEN/CPUID_LEN/ 2016-02-08 11:10:59 +01:00
Hauke Petersen
5165e48399 Merge pull request #4746 from haukepetersen/add_board_nrf52dk
cpu/boards: added support for nRF52 DK
2016-02-05 15:11:57 +01:00
Martine Lenders
8a588575f3 doc: fix link to devel mailman 2016-02-05 13:39:46 +01:00
Hauke Petersen
0b1bc39fd5 doc: adapted doxygen excludes for NRF5x headers 2016-02-05 12:07:32 +01:00
2d8f6f8a92 Merge pull request #4500 from haukepetersen/fix_doc_samd21
doc: added samd21 vendor header to doxygen excludes
2015-12-21 18:20:00 +01:00
Lotte Steenbrink
1ac9a0d227 Merge pull request #4480 from authmillenon/doc/enh/creating-modules
doc: add page about creating modules
2015-12-19 13:29:04 +00:00
Martine Lenders
b5f5f8314a doc: add page about creating modules 2015-12-19 14:18:18 +01:00
Oleg Hahm
f22cac2ceb Merge pull request #4289 from authmillenon/doc/enh/pkg
doc: move pkg/PORTING.md and pkg/USING.md to doxygen
2015-12-18 18:01:50 +01:00
Hauke Petersen
bed0aec61e doc: added samd21 vendor header to doxygen excludes 2015-12-18 11:46:08 +01:00
Martine Lenders
31702f3ce8 doc: mention create-an-application page on main page 2015-12-15 11:56:19 +01:00
Martine Lenders
80829d5eba doc: add page about creating an application 2015-12-15 11:56:19 +01:00
Martine Lenders
f285bb2349 doc: move pkg/PORTING.md and pkg/USING.md to doxygen 2015-12-09 12:07:28 +01:00
Cenk Gündoğan
9d270ad1c0 doxygen: mainpage: link to GNRC 2015-12-08 21:01:39 +01:00
Cenk Gündoğan
0b77b259ef gnrc: enhance documentation 2015-12-08 21:01:39 +01:00
Oleg Hahm
c96679f3d1 doc: include package documentation 2015-12-08 11:27:03 +01:00
Martine Lenders
2cc2adffee Merge pull request #3900 from haukepetersen/add_arduino_api
sys: added Arduino API to RIOT
2015-11-27 13:35:29 +01:00
Martine Lenders
98bd5ee09c Merge pull request #4090 from authmillenon/doc/enh/overview-graphic
doc: add RIOT overview graphic
2015-11-27 13:17:34 +01:00
Hauke Petersen
9a32fefaf1 doc: added *.hpp to be parsed by doxygen 2015-11-27 12:45:12 +01:00
Martine Lenders
1550fe85db doc: add structure graphic to mainpage 2015-11-24 21:01:42 +01:00
Martine Lenders
3fb9f90a71 doc: add graphic showing general structure of RIOT 2015-11-24 21:01:19 +01:00
Martine Lenders
4385e5cd24 doc: add Miso fonts to documentation 2015-11-24 21:01:06 +01:00
Hauke Petersen
421e69030a Merge pull request #4315 from haukepetersen/doc_periph_fixes
doc: various fixes related to 'periph'
2015-11-19 22:59:26 +01:00
Emmanuel Baccelli
e935ca4f57 modified typo in doc mainpage.md
fixed indentation
2015-11-19 22:27:31 +01:00
Hauke Petersen
95086da431 doc/drivers/sys: fixed all refs to drivers_periph_xx 2015-11-19 16:09:25 +01:00
Martine Lenders
ccab1eae82 doc: add 'Getting started' page 2015-11-19 10:20:41 +01:00
Martine Lenders
d50de568d1 doc: Update mainpage 2015-11-17 09:49:59 +01:00
Martine Lenders
505893e8e5 doc: move mainpage completely to markdown format 2015-11-16 16:24:41 +01:00
Hauke Petersen
7f32919ffb doxygen: excluded SiLabs header files 2015-10-28 13:50:34 +01:00
Paul Rathgeb
cefe2a6698 make: Blacklisted the board 'weio' for some test due to insufficient
RAM/ROM
      Blacklisted LPC11Uxx.h for doxygen
2015-10-01 20:11:48 +02:00
Martine Lenders
e6c96cde53 gnrc_sixlowpan_nd_border_router: initial import 2015-09-11 16:45:38 +02:00
Martine Lenders
c0a1258806 doxygen: include some module switches 2015-09-11 11:28:31 +02:00
Martine Lenders
132f5e1b9c gnrc_sixlowpan_nd_router: initial import 2015-09-10 02:13:44 +02:00
Oleg Hahm
09c5eab157 doc: minor update of mainpage.txt 2015-09-03 16:30:59 +02:00
Martine Lenders
b81a4dd695 gnrc_ipv6_netif: prepare for router discovery 2015-09-01 18:50:40 +02:00
1733d4a730 doc: remove obsolete transceiver documentation 2015-08-06 12:13:54 +02:00
Oleg Hahm
6a035fe910 doc: exclude sam3* completely from doxygen
Also remove doc.txt for sam3 (moved to cpu_conf.h)
2015-07-21 10:00:11 +02:00
Oleg Hahm
72bc12e146 doxygen: add make targets to build man and latex
HTML will be build per default.
2015-07-20 19:30:30 +02:00
Joakim Gebart
68ce9397cb doc/doxygen: Clean up Makefile 2015-07-16 15:44:32 +02:00
Joakim Gebart
bb6cfa1569 doc/doxygen: Use multiple arguments to dot
graphviz >1.8.10 has been released more than 10 years ago.
2015-07-16 15:43:57 +02:00
Joakim Gebart
df1efe7154 doc/doxygen/riot.doxyfile: Do not generate LaTeX by default 2015-07-16 15:43:29 +02:00
Joakim Gebart
bc58c7ba13 doc/doxygen/riot.doxyfile: Do not generate manpages by default 2015-07-16 14:44:59 +02:00
Hauke Petersen
c7d4ff7106 doxygen: adjusted exclude pattern for NRF51 2015-07-14 18:15:42 +02:00
Thomas Eichinger
7e88358135 Merge pull request #3194 from haukepetersen/mv_sam3x
cpu: rename SAM3X8E to SAM3
2015-07-14 15:42:45 +02:00
Johann F
d614cbe066 cpu/k64f: initial import for the Freescale K64F Cortex-M4 MCU 2015-07-01 23:08:02 +02:00
Hauke Petersen
d41c365632 doxygen: adjusted exclude to changed sam3 cpu name 2015-06-15 14:29:46 +02:00
Hauke Petersen
26b9e9acea doc: adapted doxygen excludes 2015-05-28 19:30:07 +02:00
Hauke Petersen
9943f51080 global: renamed cpu-conf.h into cpu_conf.h 2015-05-28 15:45:05 +02:00
af63254f4e cpu: saml21 initial commit
basic port, uart, one timer, gpio, spi working.
2015-05-22 11:47:51 +02:00
Lucas Jenß
742c39e838 Merge pull request #2881 from x3ro/clarify-stacksize-constants
Clarify and unify naming of thread-related constants (stacksize and priority)
2015-05-21 16:55:30 +02:00
Lucas Jenss
426170b064 Improve naming of thread stacksize/priority constants
As discussed in #2725, this commit renames a number of stacksize constants to
better convey their intended usage. In addition, constants for thread priority
are given a `THREAD_` prefix. Changes are:

* KERNEL_CONF_STACKSIZE_PRINTF renamed to THREAD_EXTRA_STACKSIZE_PRINTF
* KERNEL_CONF_STACKSIZE_DEFAULT renamed to THREAD_STACKSIZE_DEFAULT
* KERNEL_CONF_STACKSIZE_IDLE renamed to THREAD_STACKSIZE_IDLE
* KERNEL_CONF_STACKSIZE_MAIN renamed to THREAD_STACKSIZE_MAIN
* Move thread stacksizes from kernel.h to thread.h, since the prefix changed
* PRIORITY_MIN renamed to THREAD_PRIORITY_MIN
* PRIORITY_IDLE renamed to THREAD_PRIORITY_IDLE
* PRIORITY_MAIN renamed to THREAD_PRIORITY_MAIN
* Move thread priorities from kernel.h to thread.h since the prefix has changed
* MINIMUM_STACK_SIZE renamed to THREAD_STACKSIZE_MINIMUM for consistency
2015-05-21 00:14:23 +02:00
Joakim Gebart
c054cfa813 doc/doxygen/src/riot-footer.html: remove tab indent 2015-05-19 12:26:00 +02:00
Johann F
1d60d9870d add support for Freescale MKW2x family devices 2015-05-15 08:05:43 +02:00
Joakim Gebart
d4f7d54ba6 doxygen: Define DOXYGEN preprocessor macro 2015-05-10 09:53:41 +02:00
Joakim Gebart
262ae9b0a8 doxygen: Clean leftover doxygen_objdb_*.tmp files. 2015-05-10 08:57:28 +02:00
Oleg Hahm
d0d8852ea1 doc: order modules alphabetically 2015-04-23 09:10:56 +02:00
Martine Lenders
9238b33906 Merge pull request #2837 from OlegHahm/yadf
Yet another doxygen fix
2015-04-22 15:30:23 +02:00
Oleg Hahm
a1c963c8e4 doc: evaluate RIOTBASE/doc.txt 2015-04-21 18:53:37 +02:00
Oleg Hahm
4952d2a002 doxygen: generate graphs for includes 2015-04-21 10:00:09 +02:00