Karl Fessel
52116e1070
Merge pull request #17572 from kfessel/p-set-doxygen-example-path
...
doc: add RIOT root to doxygen example path
2022-02-28 15:42:25 +01:00
aaa2a7939d
doc: introduce debugging-aids.md, start with ubsan
2022-02-16 12:20:45 +01:00
chrysn
f7dfa2f84d
Merge pull request #17133 from chrysn-pull-requests/doc-develhelp-stackoverflow-precision
...
doc: Start documenting pseudomodules
2022-01-27 15:09:22 +01:00
chrysn
68d0c291a9
doc: Initial documentation of pseudomodules
...
Co-authored-by: Francisco <femolina@uc.cl>
2022-01-27 13:49:14 +01:00
Karl Fessel
fb9bd122b3
doc: set example path to RIOT root
2022-01-25 17:26:38 +01:00
Leandro Lanzieri
6257442e4e
doc: Add project name
2022-01-19 10:17:52 +01:00
chrysn
9b66bd59e1
rust: Add overview documentation
2021-12-19 11:15:04 +01:00
Martine Lenders
77f7db1e0d
Merge pull request #15981 from miri64/doc/enh/porting-graph
...
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 18:53:40 +02:00
Martine Lenders
aaa9512d50
doc/porting-boards.md: improve with porting graph and reference section
2021-09-16 16:54:42 +02:00
Martine Lenders
1bf18b3239
doc/doxygen/riot.doxyfile: remove obsolete and fix wrong options
2021-08-31 19:20:37 +02:00
dylad
c488f96971
doc/doxygen: increase DOT_GRAPH_MAX_NODES to 275
2021-07-27 21:20:34 +02:00
Martine Lenders
af7152eeca
doxygen: add release cycle page
2021-05-04 11:54:15 +02:00
chrysn
204a608c24
doc: Make bootloaders visible in modules
2021-02-18 14:56:20 +01:00
Akshai M
b9d84e0b3e
doc/porting-cpus.md: initial import of a CPU porting guide
2021-02-10 15:45:59 +01:00
c9e0604612
doc: add emulator documentation
2021-01-13 17:14:39 +01:00
Karl Fessel
2e9bdf0635
doc: add jquerry.scrollTo for less timers in html doc
...
see #15503
add jquerry.scrollTo
add the code to copy and load scrollTo
2020-11-24 20:28:47 +01:00
Gilles DOFFE
f07f93fec9
doxygen: increase DOT_GRAPH_MAX_NODES
...
Signed-off-by: Gilles DOFFE <gilles.doffe@savoirfairelinux.com>
2020-09-02 11:11:29 +02:00
Marian Buschsieweke
cf482c5d46
build system: Add libstdcpp feature and doc
...
- Add libstdcpp feature to indicate a platform is providing a libstdc++
implementation ready for use
- The existing cpp feature now only indicates a working C++ toolchain without
libstdc++. (E.g. still useful for the Arduino compatibility layer.)
- Added libstdcpp as required feature were needed
- Added some documentation on C++ on RIOT
2020-07-15 11:45:22 +02:00
Chamaeleon-
f76b88177c
doc/doxygen: enable svg output
...
changed DOT_IMAGE_FORMAT to svg to get searchable dependency and call graphs
2020-04-30 12:55:31 +02:00
8069c8e5a1
doxygen: increase DOT_GRAPH_MAX_NODES
2020-03-03 14:09:37 +01:00
ab9c67e621
Merge pull request #13257 from fjmolinas/pr_creating_boards_md
...
doc/doxygen: add creating boards doc
2020-02-12 08:40:53 +01:00
Francisco Molina
a348f1db48
doc/doxygen: add creating boards doc
2020-02-11 16:50:50 +01:00
Leandro Lanzieri
3416205de0
doc: Move Kconfig next to build system section
2020-02-05 13:32:12 +01:00
Leandro Lanzieri
ab3cea197f
doc: Add Kconfig documentation section
...
This adds information regarding the usage of Kconfig from an user
perspective and in-depth information on how Kconfig is currently
integrated to RIOT's build system.
2020-01-17 09:49:38 +01:00
c68470fc3d
Merge pull request #12783 from maribu/driver_guide
...
doc: move device driver guide to a doxygen page
2019-11-28 19:00:27 +01:00
Marian Buschsieweke
7108394172
doc/driver-guide.md: Doxygen integration
...
- Added the file to `riot.doxyfile`
- Shortened the header to display properly
- Added `[TOC]` to let doxygen create a table of contents
- Added manual anchors to the headers for consistency with other doc files
- Use @code and @endcode for code blocks (using fenced blocks doesn't parse
with the Doxygen version used by the CI)
- Changed a numbered list containing code blocks to regular text, as the code
blocks as list items are not parsed correctly
2019-11-28 13:58:26 +01:00
Francisco Molina
5212e86226
doc/doxygen: add build-system-basics.md
2019-11-27 17:32:03 +01:00
Francois Berder
4a31f94cfc
many typo fixes
...
Signed-off-by: Francois Berder <18538310+francois-berder@users.noreply.github.com>
2019-11-23 22:39:07 +01:00
Benjamin Valentin
0ea2cbf1eb
boards: remove RTT_NUMOF/RTC_NUMOF
...
Those macros are defined but never used.
2019-11-08 14:20:33 +01:00
Martine S. Lenders
0a2945164c
lwip: improve and fix documentation
2019-10-09 14:45:30 +02:00
Martine S. Lenders
0d8511616a
emb6: fix documentation
2019-10-09 11:27:52 +02:00
MrKevinWeiss
7bd633a8b2
tests/doc: Add intial how to test doc
...
This commit adds a README.md to the testing folder.
It explains the basic about how to run a test with testrunner.
It adds a reference so it will be displayed on the doxygen docs.
There currently is not obvious documentation for running tests.
2019-03-24 15:15:35 +01:00
Gunar Schorcht
e7b153cf80
doc: remove *_params.h from EXCLUDE_PATTERNS
2019-02-08 18:05:21 +01:00
Gunar Schorcht
b18d312ef5
doc: set STRIP_FROM_PATH
...
Set STRIP_FROM_PATH=../../ avoids having the output depend on the location of the RIOT repo in the user's fs.
2019-02-08 18:05:21 +01:00
Gunar Schorcht
20d5f30ad4
doc: set FULL_PATH to yes
...
Using FULL_PATH=yes avoids that paths in documentation seem to be arbitrary.
2019-02-08 18:05:21 +01:00
Gunar Schorcht
cdcf503adf
doc: remove STRIP_FROM_INC_PATH
...
To be able to include *_params.h in docuementation, STRIP_FROM_INC_PATH has to be empty. Otherwise, a number of warnings are thrown if *_params.h files with same names exist in different directories.
2019-02-08 18:05:21 +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
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
Martine Lenders
8e5e2061e9
doc: doxygen: add command
2018-04-13 17:55:15 +02: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
Hauke Petersen
dcd297d837
doxygen: remove x86-multiboot from excludes
2017-11-16 13:42:03 +01:00
a7d575b8d6
doc: increase GRAPH_MAX_NODES to avoid warning
2017-11-05 22:14:30 +01: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
