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
Martine Lenders
d145b0d7d8
doc: generate-changelog: add support for point releases
2021-01-08 14:46:10 +01:00
b8efd8425d
doc/kconfig: fix typo (bellow => below)
2021-01-08 10:15:32 +01:00
Martine Lenders
a28af88e02
doc: add link to forum on the main page
2020-12-10 10:10:03 +01:00
b31357eccc
doc: update Makefile.include instructions
...
Specify the programmer using the PROGRAMMER variable, don't include programmer specific makefile and serial makefile
2020-12-02 11:57:10 +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
benpicco
be9eb22bb8
Merge pull request #15106 from chrysn-pull-requests/saul-rgbleds
...
saul_pwm: auto-init'able RGB LEDs and dimmers
2020-11-13 18:22:30 +01:00
5281a1b155
doc: add Docker info to doxygen
2020-11-13 11:50:50 +01:00
chrysn
d196c7c4a6
drivers/saul/auto_init: Add PWM for LEDs
...
In analogy to the existing GPIO mappings, this provides (write-only)
SAUL entries for PWM'd LEDs in a single-LED (as SAUL_ACT_DIMMER) and an
RGB (as SAUL_ACT_RGB_LED) mode.
Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de>
2020-10-17 11:20:17 +02:00
benpicco
5c9e0dfa93
Merge pull request #15154 from aabadie/pr/doc/cleanup_readme
...
README.md: move tapsetup section to documentation
2020-10-06 10:31:25 +02:00
c07805fb07
Merge pull request #15152 from bergzand/pr/doxygen/square_faviconpng
...
doxygen: Replace favicon with square png
2020-10-03 16:40:08 +02:00
b5b3491726
doc: add tapsetup note in getting-started page
2020-10-03 16:03:05 +02:00
10aaca82aa
doxygen: Replace favicon with square png
...
The previous favicon was a 35x40 png file. Some (if not all) browsers
stretch the icon to a square. This stretched the original favicon
without keeping the aspect ratio. This commit replaces the favicon with
a square 128x128 png image.
2020-10-03 14:34:55 +02:00
Francisco
df3ab9f161
Merge pull request #15138 from aabadie/pr/dist/codespell_fixes
...
dist/codespell: update the list of ignored words and fix all typos
2020-10-02 12:27:12 +02:00
f8b78593a2
doc: fix typos
...
- 'adminstrative' -> 'administrative'
- 'Ouput' -> 'Output'
2020-10-02 08:00:51 +02:00
2213b25f8f
doc/kconfig: mention possible intermediate CPU levels
...
Such as CPU_LINES_<xxx> on STM32
2020-10-01 18:25:35 +02:00
a239bcb015
doc: Extend tricks with Make-only board selector
...
This extends the 'Advanced build system tricks' section with a make
script to select the board debugger and serial based on the USB serial
number as reported by the device. This solution is different from the
udev-rule solution as it doesn't require administrative permissions.
2020-09-28 14:26:46 +02:00
Marian Buschsieweke
4a016adebb
doc/driver-guide.md: Update doc on return value
...
Change driver guide to expect drivers to return negative errno codes instead of
enums for error codes. Those have the following advantages:
- More efficient implementation of POSIX compatibility wrappers:
- In case of error, just an `errno = -retval; return -1` is needed
- Better interoperability
- A lot of code within RIOT and in external code is doing so already.
Applying this consistently allows passing error codes through, rather
than translating between errno codes and custom enum values
- Not reinventing the wheel
- Defining and documenting custom error codes for each driver is unneeded
effort
- The error classes that device driver have to report are largely the same.
There is no reason to have dozens of error codes for an input/output
error, each with a unique spelling a programmer needs to memorize
2020-09-22 14:38:56 +02: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
Leandro Lanzieri
d25fc243c4
treewide: change prefix for generated Kconfig symbols.
...
This changes the prefixes of the symbols generated from USEMODULE and
USEPKG variables. The changes are as follow:
KCONFIG_MODULE_ => KCONFIG_USEMODULE_
KCONFIG_PKG_ => KCONFIG_USEPKG_
MODULE_ => USEMODULE_
PKG_ => USEPKG_
2020-08-31 09:37:09 +02:00
Leandro Lanzieri
8feb03c18d
doc/kconfig: update to current behaviour and used files
2020-08-07 18:17:38 +02:00
benpicco
f3bce19646
Merge pull request #14503 from maribu/cpp-feature
...
build system: Add libstdcpp feature and doc
2020-07-23 19:05:10 +02:00
628777fa90
doc: adapt driver guide documentation
2020-07-15 20:36:27 +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
Karl Fessel
e91dc15304
doc/search: do not hide search on mobile and make it work
...
move and resize results if they are not within the document-window
modify the search result display with some javascript patching
(in page grease(tamper)monkey approach)
2020-07-04 15:15:58 +02:00
Karl Fessel
5e757b1a9c
doc/search: Patch search to display results bigger if hitting return
2020-07-03 23:40:00 +02:00
Leandro Lanzieri
045874abe6
Merge pull request #14050 from akshaim/Documentation_Update
...
doc/driver-guide.md : Update for compile-time configuration
2020-07-02 09:59:13 +02:00
Akshai M
d379009488
doc/driver-guide.md : Fix typo, punctuations and sentences
2020-07-01 21:59:42 +05:30
Akshai M
39a36f7fef
doc/driver-guide.md : Fix syntax
2020-07-01 21:20:10 +05:30
Akshai M
b5902cadd5
doc/driver-guide.md : Update for compile-time configuration
...
Co-authored-by: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
Co-authored-by: Martine Lenders <mail@martine-lenders.eu>
2020-07-01 21:20:10 +05:30
Karl Fessel
f09064c40c
doc/header: make hitting return not reload the page
...
adding onsubmit="return false" stops form submition which leads to reload
2020-07-01 12:58:05 +02:00
Leandro Lanzieri
b8486782f0
doc/kconfig: Add guide to model features, CPUs and boards
2020-06-29 13:35:32 +02:00
Akshai M
879263c1d2
doc/kconfig.md : Added Appendix D
...
Added a new section, Appendix D, to describe a few key aspects
while exposing a macro to Kconfig.
Co-authored-by: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
2020-06-03 20:04:38 +05:30
0b778fec46
doc/porting-boards: add section about board generator
2020-05-20 19:05:40 +02:00
bdf4efa9bb
doc/creating-application: add section about example/test generator
2020-05-20 19:05:40 +02:00
f4ea2b97c8
doc/creating-modules: add section about module generator
2020-05-20 19:05:40 +02:00
26d3bc3b42
doc/driver-guide: add section about driver generator
2020-05-20 19:05:40 +02:00
53ea5ff883
doc/build-system-basics: fix typo
2020-05-08 11:29:39 +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
Francisco
919249f361
Merge pull request #13862 from maribu/extra_boards
...
Makefile*: Allow multiple external board dirs
2020-04-29 20:12:06 +02:00
Marian Buschsieweke
ba7815163c
Makefile*: Allow multiple external board dirs
...
- Add the new EXTERNAL_BOARD_DIRS variable that can contain a space separated
list of folders containing external boards
- Introduce $(BOARDDIR) as shortcut for $(BOARDSDIR)/$(BOARD)
- Map the existing BOARDSDIR to the new approach
- If BOARDSDIR is provided by the user, it will be added to
EXTERNAL_BOARD_DIRS for backward compatibility. (And a warning is issued
to encourage users migrating to EXTRA_BOARDS.)
- BOARDSDIR is updated after the board is found to "$(BOARDDIR)/..".
- Useful for `include $(BOARDSDIR)/common/external_common/Makefile.dep`
- Provides backward compatibility
2020-04-29 18:32:39 +02:00
Francisco Molina
67910a1219
doc/creating-modules.md: correct PSEUDOMODULES documentation
2020-04-21 09:25:06 +02:00
Marian Buschsieweke
3628db19fd
Makefile.features: Allow "one out of" dependencies
...
An application/test/module that requires one feature out of a set of
alternatives (let's say either periph_uart, periph_spi, or periph_i2c) can
request this now using:
FEATURES_REQUIRED_ANY += periph_uart|periph_spi|periph_i2c
2020-04-01 09:12:50 +02:00
Gunar Schorcht
2d0ee5ca67
doc/porting-boards: fix broken links
2020-03-24 10:38:40 +01:00
8069c8e5a1
doxygen: increase DOT_GRAPH_MAX_NODES
2020-03-03 14:09:37 +01:00
Jan Mohr
67569fbd56
doc/creating-modules: updated Pseudomodules entry
2020-02-28 16:51:53 +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
efea82eb7a
doc: Add section on configuration in 'getting started' page
2020-02-05 15:51:55 +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
784920b755
Merge pull request #12473 from fjmolinas/pr_board_cpu_features_doc
...
doc/doxygen: add build system doc page for BOARD, CPU, FEATURE
2020-01-15 17:35:37 +01:00
Francisco Molina
963ec794d2
doc/doxygen: add build system doc page for BOARD, CPU, FEATURE
2020-01-15 15:53:03 +01:00
fc28ac2a58
Merge pull request #12573 from fjmolinas/pr_doc_udev_rules
...
doc/advanced-build-system-tricks: handle multiple boards
2020-01-15 07:05:44 +01:00
Francisco Molina
4770b3c36b
doc/advanced-build-system-tricks: handle multiple boards
2020-01-14 15:48:33 +01:00
Marian Buschsieweke
3cff7c022e
doc: Update CSS for readable @retval tables
...
Currently now margin between the return value and its description are added in
return value tables generated with the @retval command. This adds a 2em margin,
which is consistent with the margin after parameter names in the parameter
table.
2020-01-08 15:20:08 +01:00
Francisco
f6f4469542
Merge pull request #11889 from miri64/tapsetup/enh/sudo
...
tapsetup: require to be executed with sudo
2020-01-04 10:43:06 +01:00
Martine S. Lenders
38f76f951d
doc: adapt doc on tapsetup for new sudo requirement
2020-01-03 21:00:54 +01:00
Jue
bc46c7478f
drivers: add Differentially Operated Serial Ethernet driver
2019-12-16 10:43:13 +01:00
jasdeepgill
75770b5641
doc: minor text fix for mainpage.md
...
Rearranged sentence so that only one 'and' is used in the sentence
2019-11-30 14:49:55 +01:00
Benjamin Valentin
97d8e9fec1
doc/driver-guide.md: fix typo
2019-11-28 19:33:35 +01:00
Benjamin Valentin
a8b540adcf
doc/driver-guide.md: add a note about float
...
floating point variables should generally be avoided.
2019-11-28 19:11:33 +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
Marian Buschsieweke
267253dc5c
doc/driver-guide.md: Applied coding convention
...
- Enforce 80 chars per line limit
- Fixed some typos
- Removed trailing whitespace
- Added markdown syntax for code highlight in two cases
- Reduced the TODO section heading from level 1 to level 2
==> No content changes
2019-11-28 13:57:47 +01:00
Francisco Molina
5212e86226
doc/doxygen: add build-system-basics.md
2019-11-27 17:32:03 +01:00
Marian Buschsieweke
86ba1043a2
Added driver guide verbatim
...
Copied the contents of a680cbf442
2019-11-25 10:11:35 +01:00
889dba2aed
doc: fix typos
2019-11-23 22:39:38 +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
Ken Bannister
3e0a3b1746
Merge pull request #12389 from miri64/pkg/depr/emb6
...
emb6: deprecate package
2019-10-09 06:53:50 -04:00
Martine S. Lenders
0d8511616a
emb6: fix documentation
2019-10-09 11:27:52 +02:00
Francisco
1c5c027ee7
Merge pull request #12004 from cladmi/pr/make/dependencies/debug_targets
...
make: add targets to debug dependencies variables
2019-10-08 17:41:34 +02:00
Gaëtan Harter
9940a15bcc
doc: add documentation on dependency debug targets
...
Add short documentation for the dependency resolution debug targets.
Point to the main files for more infos.
2019-10-08 11:26:29 +02:00
Marian Buschsieweke
6bf5dd2963
doc/doxygen: Use python3 in generate-changelog.py
2019-09-10 10:10:12 +02:00
Emmanuel Baccelli
793072cb13
Merge pull request #10162 from danpetry/doc/rdm1-RIOT-design-goals
...
doc/rdm: RFC - design goals
2019-05-09 11:04:24 +02:00
danpetry
c3bd937128
doc/rdm: Update README contents
...
Update README to include a reference to the new document.
2019-05-03 16:26:47 +02:00
danpetry
6ea67abefc
doc/rdm: rdm1 - RIOT design goals
...
Initial commit of document.
2019-05-03 16:26:46 +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
Juan I Carrano
6c7984e52d
Merge pull request #11037 from cladmi/pr/doc/remove_lesscpy
...
doc/doxygen: remove support for lesscpy
2019-03-06 15:25:11 +01:00
Gaëtan Harter
944d0f31af
doc/doxygen: add package name for lessc
...
Add package name in ubuntu for lessc.
2019-02-20 11:35:06 +01:00
Gaëtan Harter
37349a0b19
doc/doxygen: remove support for lesscpy
...
lessc (node-less) and lesscpy do not produce the same output.
There are some minor whitespace +-1 in color values which
are not important but the output file is not stable
However lesscpy removes comments and so the license of the output file
As it produces an invalid file it support is dropped.
https://lesscpy.readthedocs.io/en/latest/#differences-from-less-js
2019-02-20 11:32:10 +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
Martine Lenders
92b5ef594c
doc: add reference to RIOT paper
2019-01-25 20:33:14 +01:00
danpetry
b79910995d
doc/rdm: clarification to change process
2019-01-17 12:06:28 +01:00
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
Emmanuel Baccelli
48c981b1e2
rdm : initial rdm directory + rdm0
2018-10-12 19:11:08 +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
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
Joakim Gebart
de486ff79f
k60: Initial commit of K60 CPU.
...
Tested on the following Freescale Kinetis K60 CPUs:
- MK60DN512VLL10
The port should with a high probability also support the following variations of the above CPUs (untested):
- MK60DN256VLL10
And possibly also:
- MK60DX256VLL10
- MK60DX512VLL10
- MK60DN512VLQ10
- MK60DN256VLQ10
- MK60DX256VLQ10
- MK60DN512VMC10
- MK60DN256VMC10
- MK60DX256VMC10
- MK60DN512VMD10
- MK60DX256VMD10
- MK60DN256VMD10
Currently not working on the following CPUs (Missing PIT channel
chaining necessary for kinetis_common/periph/timer implementation):
- MK60DN256ZVLL10
- MK60DN512ZVLL10
- MK60DX256ZVLL10
- MK60DX512ZVLL10
- MK60DN512ZVLQ10
- MK60DN256ZVLQ10
- MK60DX256ZVLQ10
- MK60DN512ZVMC10
- MK60DN256ZVMC10
- MK60DX256ZVMC10
- MK60DN512ZVMD10
- MK60DX256ZVMD10
- MK60DN256ZVMD10
Regarding header files from Freescale:
dist/tools/licenses: Add Freescale CMSIS PAL license pattern
Redistribution is OK according to:
https://community.freescale.com/message/477976?et=watches.email.thread#477976
Archive copy in case the above link disappears:
https://web.archive.org/web/20150328073057/https://community.freescale.com/message/477976?et=watches.email.thread
Applies to:
- MK60DZ10.h (K60 variant)
2015-03-28 08:30:13 +01:00
Martine Lenders
21dd2eb21d
doc: enable helper macros for doxygen
2015-03-03 17:53:32 +01:00
Hauke Petersen
b435a488fa
Merge pull request #2026 from thomaseichinger/stm32l1
...
stm32l1: initial port for the nucleo-l1 board and stm32l1 cpu
2015-01-12 21:33:21 +01:00
Thomas Eichinger
07d76d7127
stm32l1: initial port for the nucleo-l1 board and stm32l1 cpu
2015-01-12 15:13:19 +01:00
Ludwig Ortmann
87da25eab3
doxygen: enable latex batchmode
...
Instruct the latex processor to keep going if an error occurs.
2015-01-10 08:29:34 +01:00
Oleg Hahm
3458b745a0
doc: order the main modules in a more sensible way
2014-12-11 17:26:26 +01:00
Ludwig Ortmann
da43a5e7a4
doc: periph: various fixes and cleanup
...
- unify file/module @brief
- distinct @file section more visibly in source
- provide missing @brief's
- move module details/notes from file to module sections
- provide missing macro definition for building
2014-12-04 10:28:45 +01:00
Oleg Hahm
7e6ac37a55
doc: exclude vendor specific headers from doxygen
...
Also, periph_conf contains mostly the same macros that don't need to be
documented in every single instance.
2014-11-28 14:26:56 +01:00
Ludwig Ortmann
8f76622ebf
doc: add doxygen predefines for periph headers
2014-10-24 16:57:50 +02:00
Oleg Hahm
c53bd9ca5d
doc: remove more CPU specific documentation
2014-10-23 20:53:01 +02:00
Oleg Hahm
c0bcac460e
doc: beautify HTML documentation
...
* add logo
* add description
* use RIOT specific color scheme
* add search functionality
* remove broken custom header, footer, and style sheet
2014-10-23 20:53:01 +02:00
Oleg Hahm
b066433bdc
doc: improve doxygen cache size
2014-10-23 20:53:01 +02:00
Oleg Hahm
49208ffb59
doc: exclude more CPU specific stuff from doxygen
2014-10-23 20:53:00 +02:00
Oleg Hahm
0a040f8b79
doc: updated doxygen configuration
...
Updated with `doxygen -u`
2014-10-23 17:29:25 +02:00
Oleg Hahm
6d8c0d74c3
doc: some doxygen cleanups
...
* removed RIOT unrelated cpu documentation
* introduced cpu_specific prefix to mark such documentation
* put oneway_malloc and crypto into sys group
2014-10-23 17:29:25 +02:00
Ludwig Ortmann
43b191fa00
make: make doc clean target ignore failures
2014-10-10 15:12:54 +02:00
Ludwig Ortmann
ee4ea7e1c5
doc: doxygen: EXTRACT_STATIC = YES
2014-07-29 14:37:33 +02:00
Leon George
38bd27757b
doc: mainpage.txt fixed minor mistake
2014-07-20 21:21:58 +02:00
Thomas Eichinger
1e983c9670
s/PROJECT/APPLICATION/g
...
fixes #548
2014-05-26 13:21:09 +02:00
Martin Lenders
39854c7718
Exclude *.c files from make doc
2014-05-12 02:40:09 +02:00
