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
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
Martine Lenders
b092179787
doc: utilize smartmenus
2017-04-25 09:35:50 +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
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
Joakim Nohlgård
125e3b0125
doc: Add some missing excludes
2017-01-17 14:55:32 +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
Andreas Paul Pauli
bce61166ee
doc: provide include path list for riot.doxyfile
2016-03-23 23:01:46 +01:00
d9cf871e2e
sys: random: import tinymt32 PRNG
2016-02-29 12:05:31 +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
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
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
Oleg Hahm
c96679f3d1
doc: include package documentation
2015-12-08 11:27:03 +01:00
Hauke Petersen
9a32fefaf1
doc: added *.hpp to be parsed by doxygen
2015-11-27 12:45:12 +01:00
Martine Lenders
ccab1eae82
doc: add 'Getting started' page
2015-11-19 10:20:41 +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
Martine Lenders
b81a4dd695
gnrc_ipv6_netif: prepare for router discovery
2015-09-01 18:50:40 +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
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
af63254f4e
cpu: saml21 initial commit
...
basic port, uart, one timer, gpio, spi working.
2015-05-22 11:47:51 +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
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
ee4ea7e1c5
doc: doxygen: EXTRACT_STATIC = YES
2014-07-29 14:37:33 +02:00
Martin Lenders
39854c7718
Exclude *.c files from make doc
2014-05-12 02:40:09 +02:00
Ludwig Ortmann
2525920426
remove trailing whitespace and newlines
2014-02-11 18:45:06 +01:00
Hauke Petersen
c629229e8d
Added the boards folder to the doxygen tree
...
- added boards to riot.doxyfile
- fixed group definitions for all boards
2013-12-16 14:00:37 +01:00
authmillenon
590b05fc1b
Tell Doxygen to ignore __attribute__
...
Doxygen can't handle it properly (see
http://doxygen.10944.n7.nabble.com/struct-attribute-packed-not-working-td2666.html )
2013-08-08 23:49:33 +02:00
