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

416 Commits

Author SHA1 Message Date
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
Christian Mehlis
cb9c5d00de repace project by application in documentation 2014-02-18 12:28:32 +01:00
Ludwig Ortmann
6663e7c2fb fix wiki links 2014-02-12 16:54:38 +01:00
Ludwig Ortmann
2525920426 remove trailing whitespace and newlines 2014-02-11 18:45:06 +01:00
Ludwig Ortmann
a4a1c39d95 substitute folder with directory 2014-01-22 20:17:07 +01:00
Oleg Hahm
e8f19cb884 added paragraph about stack sizes and fixed formatting 2014-01-21 11:01:11 +01:00
Oleg Hahm
8695e3b102 added information from Introduction page to the API start page 2014-01-17 11:54:38 +01:00
Oleg Hahm
7335cd71c7 removed getting started documents as it has been merged into the wiki 2014-01-17 11:54:37 +01:00
Oleg Hahm
5403003735 removed getting started text from doxygen mainpage 2014-01-17 11:52:41 +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
Ludwig Ortmann
b926309380 Add native network README link to getting started. 2013-09-17 14:42:45 +02:00
Oleg Hahm
e69acfbba1 Remove the optionnal parameter for hello-world 2013-09-17 14:08:10 +02:00
Oleg Hahm
015e6fd8d4 fixed formatting 2013-08-16 12:12:28 +02:00
Oleg Hahm
26fa6c39bd Inform about submodule and added tarballs 2013-08-16 12:09:17 +02:00
authmillenon
a3b754b662 Remove carriage returns
Git for windows handles those by itself
2013-08-15 10:17:15 +02: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
Thomas Eichinger
3dba62afa6 Merge branch 'mc1322x' of github.com:RIOT-OS/RIOT into mc1322x 2013-04-22 09:56:07 +02:00
Oliver Hahm
4c97cb1642 * updated getting started documentation 2013-04-17 12:09:42 +02:00
Oleg Hahm
0f98e30230 * added getting started document 2013-04-12 18:11:02 +02:00
Oliver Hahm
b6f21700ce * clean up stuff (fix gcc warnings and added clean target for doc) 2013-04-02 02:02:58 +02:00
Ludwig Ortmann
512d5aab0a fix path in doxyfile to match current structure 2013-03-13 21:47:32 +01:00
Oleg
1c3a4f3ae9 Update mainpage.txt 2013-03-11 16:21:15 +01:00
Oliver Hahm
0d06e1bc18 Merge branch 'master' of github.com:RIOT-OS/RIOT 2013-03-10 16:46:46 +01:00
Oliver Hahm
5ffe5a9c27 * renamed makefiles to Makefile 2013-03-09 23:45:56 +01:00
Oleg Hahm
dd32345011 * included modifications suggested by Ludwig 2013-03-08 13:54:23 +01:00
Oleg Hahm
4f45305805 * created a mainpage for the RIOT documentation 2013-03-07 22:22:25 +01:00
Oleg Hahm
77859ebc90 * fixed path for riot.css 2013-03-07 21:10:42 +01:00
Oleg Hahm
7913868bc9 * changed html stylesheet to custom one 2013-03-07 21:04:46 +01:00
Oleg Hahm
2277b366b2 * removed outdated occurrences of (u|µ)kleos and FeuerWare 2013-03-07 20:51:26 +01:00
Oleg Hahm
f6932d3941 * removed manual.doc 2013-03-07 20:20:58 +01:00
Oleg Hahm
f6e129959e * created a target to build the documentation 2013-02-08 19:34:07 +01:00
Oliver Hahm
3b218ec24a * changed API for rtc
* added drivers directory to doxygen file
* added missing include to sht11 header
* added rtc and sht11 support to default project
* added rtc to auto_init
* added rtc and sht11 support to shell
2010-11-04 18:16:39 +01:00
4574aa6f8f * doc: added base manual document 2010-09-22 15:30:11 +02:00
91ae1eb6fd * import from old firekernel repository 2010-09-22 15:10:42 +02:00