Marinus Enzinger
dc8b8d7749
doc: add example for problems arising from non unique module names
2019-01-07 15:29:25 +01:00
Gaëtan Harter
e47fea7bf5
doc/advanced-build-system-tricks.md: add a doc for new variables
...
Add a documentation page for advanced low level tricks.
Document the `RIOT_MAKEFILES_GLOBAL_PRE` and
`RIOT_MAKEFILES_GLOBAL_POST`.
I could not work around to have `$(RIOTBASE)/Makefile.include` in the
doc as the `$()` part was removed, so I kept with `$RIOTBASE` for now.
2018-12-07 17:05:51 +01:00
Gaëtan Harter
4157a07152
tests/external_module_dir: test for EXTERNAL_MODULE_DIRS
...
It demonstrates:
* Adding a module with source code
* Setting a header include directory
* Adding dependences, which are evaluated before other modules dependencies
If the application compiles, everything is ok.
2018-10-23 13:22:25 +02:00
Gaëtan Harter
6b534a935f
make: process include and dep for external modules
...
Process `Makefile.include` for external modules. It is included after the others
so it could overwrite some of the configuration if wanted.
Process `Makefile.dep` for external modules. It is included before the others so
it could be parsed before setting 'default' values to dependencies.
2018-10-23 13:22:25 +02:00
43c2b3201d
doc/doxygen: fix typo in getting started page
2018-10-05 09:48:02 +02:00
Lotte Steenbrink
5a1184880a
mainpage.md: fix dead link and 3 typos
2018-09-25 19:43:16 +02:00
Jose Alamos
7d286ec3f3
doc: set SUBGROUPING to NO in riot.doxyfile
2018-08-29 17:57:13 +02:00
Cenk Gündoğan
dc3c49ea88
Merge pull request #8948 from miri64/doc/enh/experimental-command
...
doc: doxygen: add command
2018-06-26 22:33:33 +02:00
Bas Stottelaar
6464e12713
doc: exclude fortuna sources
2018-05-29 18:40:59 +02:00
Yegor Yefremov
b5527911f1
doc: fix quick guide command order
...
git checkout can only work if you've already changed to RIOT folder.
2018-05-25 12:22:09 +02:00
9001b165f6
doc: fix flake8 in generate changelog script
2018-04-27 15:15:09 +02:00
Gaëtan Harter
051d192e7f
doc: fix 'EXTERNAL_MODULES_DIRS' name
...
Name in the documentation did not match the one in Makefile.include.
2018-04-19 13:20:19 +02:00
Martine Lenders
8e5e2061e9
doc: doxygen: add command
2018-04-13 17:55:15 +02:00
61f1b941ce
make: replace curly braces with parenthesis
2018-03-22 20:43:15 +01:00
Martine Lenders
2c318e80dc
Merge pull request #8780 from miri64/doc/fix/dead-gmane-links
...
doc: mainpage: fix dead Gmane links
2018-03-15 12:34:26 +01:00
Martine Lenders
2475254d25
doc: mainpage: fix dead Gmane links
...
Gmane is sadly offline since 2016, so let's link to our own (not so
nice) archive for now, so people can still at least crawl through it.
2018-03-14 16:13:32 +01:00
Gaëtan Harter
e5d234e2f4
doc: add warning that MODULE name should be unique
...
Modules produce an output archive called `${MODULE}.a` if several modules use
the same name, the output is overwritten.
2018-03-14 12:29:22 +01:00
e5bce7af82
doc/doxygen: enable doc on openthread package
2018-03-07 11:10:32 +01:00
e73cc86b87
doc/doxygen: enable doc on nordic_softdevice_ble pkg
2018-03-01 15:31:08 +01:00
0276bef20c
doc/doxygen: enable doc on semtech-loramac package
2018-03-01 14:06:54 +01:00
e764a60a9a
doc/doxygen: enable parsing of packages docs
...
Exception are made for emb6, nordic_softdevice_ble, openthread and semtech-loramac because their documentation contains warning/issues
2018-02-28 14:49:19 +01:00
Martine Lenders
3dec4720b8
doc: replace conn with sock in GNRC architecture overview
2018-02-27 11:02:39 +01:00
Hauke Petersen
dcd297d837
doxygen: remove x86-multiboot from excludes
2017-11-16 13:42:03 +01:00
Joakim Nohlgård
22c52bd3a8
kinetis: Unify all Kinetis CPUs in one directory
2017-11-10 10:42:59 +01:00
a7d575b8d6
doc: increase GRAPH_MAX_NODES to avoid warning
2017-11-05 22:14:30 +01:00
Joakim Nohlgård
329517f08d
boards: Remove executable bit on various non-executable files
2017-10-13 10:29:34 +02:00
Joakim Nohlgård
d01d91d3c3
doxygen: Use lesscpy if lessc is not found
2017-09-28 19:27:50 +02:00
smlng
6ac0922c7d
doc: replace dashes
2017-09-06 08:49:05 +02:00
Joakim Nohlgård
e08cb90b12
Merge pull request #7520 from haukepetersen/rm_weio_lostandfound
...
doc: added LOSTANDFOUND.md
2017-09-04 11:58:15 +02:00
Hauke Petersen
627596eece
doxygen: added removed feature document as page
2017-09-01 14:26:39 +02:00
Joakim Nohlgård
b621cb54a8
doc: Enable REPEAT_BRIEF in Doxygen
...
The detailed documentation of some functions need the brief description
included to make sense.
2017-08-11 07:49:52 +02:00
0ba641a6d2
doc: restore syntax highlight in C snippet + increase padding of code fragment blocks
2017-07-17 18:15:46 +02:00
Martine Lenders
36c7eb9ac8
doc: fix rendering of multi-breadcrumbed groups
2017-07-03 17:05:54 +02:00
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.
2017-06-25 13:49:48 +02:00
Raul Fuentes
1c0653f383
Doxygen: Completed line for Makefile.base
2017-05-30 20:48:57 +02:00
Martine Lenders
cac6da3fb7
doc: fix "Creating an application" page
2017-05-24 18:23:30 +02:00
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.
2017-05-12 17:54:48 +02:00
Joakim Nohlgård
032c3b6883
Merge pull request #6914 from miri64/doc/fix/smartmenus
...
doc: utilize smartmenus
2017-04-25 11:05:45 +02:00
Martine Lenders
b092179787
doc: utilize smartmenus
2017-04-25 09:35:50 +02:00
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
