[riot-commits] [RIOT-OS/RIOT] 6d8c0d: doc: some doxygen cleanups

Oleg Hahm oleg at hobbykeller.org
Fri Oct 24 16:04:03 CEST 2014


  Branch: refs/heads/master
  Home:   https://github.com/RIOT-OS/RIOT
  Commit: 6d8c0d74c3622fafd61a89b119dfed6e28c9634f
      https://github.com/RIOT-OS/RIOT/commit/6d8c0d74c3622fafd61a89b119dfed6e28c9634f
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/nrf51822/include/nrf51.h
    M cpu/samd21/include/samd21.h
    M cpu/stm32f0/include/stm32f051x8.h
    M cpu/stm32f1/include/cpu-conf.h
    M cpu/stm32f1/include/stm32f10x.h
    M cpu/stm32f3/include/stm32f303xc.h
    M cpu/stm32f4/include/stm32f407xx.h
    M cpu/stm32f4/include/stm32f415xx.h
    M doc/doxygen/riot.doxyfile
    M sys/crypto/doc.txt
    M sys/oneway-malloc/include/malloc.h

  Log Message:
  -----------
  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


  Commit: 0a040f8b79052507ff254c945e7e958332cc4476
      https://github.com/RIOT-OS/RIOT/commit/0a040f8b79052507ff254c945e7e958332cc4476
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M doc/doxygen/riot.doxyfile

  Log Message:
  -----------
  doc: updated doxygen configuration

Updated with `doxygen -u`


  Commit: 18381661dc84bc6402bf5d59fc93066cf40d8e31
      https://github.com/RIOT-OS/RIOT/commit/18381661dc84bc6402bf5d59fc93066cf40d8e31
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M core/include/hwtimer.h

  Log Message:
  -----------
  doc: fix documentation for hwtimer

@verbatim was used incorrectly and a closing html tag was missing


  Commit: 206b75933ee32adb99740735ab211524352512c9
      https://github.com/RIOT-OS/RIOT/commit/206b75933ee32adb99740735ab211524352512c9
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M core/include/arch/hwtimer_arch.h
    M core/include/byteorder.h
    M core/include/debug.h
    M core/include/kernel.h
    M core/include/kernel_internal.h
    M core/include/kernel_types.h
    M core/include/lifo.h
    M core/include/thread.h
    M sys/include/vtimer.h

  Log Message:
  -----------
  doc: fixed remaining doxygen warnings in core

Only one warning remains and will be fixed in a separate commit.


  Commit: 49208ffb599d18fef443081e14af2ddc58d77519
      https://github.com/RIOT-OS/RIOT/commit/49208ffb599d18fef443081e14af2ddc58d77519
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/cortex-m3_common/doc.txt
    M doc/doxygen/riot.doxyfile

  Log Message:
  -----------
  doc: exclude more CPU specific stuff from doxygen


  Commit: b186b177a5cd7211bf80c4a22298e60b53384704
      https://github.com/RIOT-OS/RIOT/commit/b186b177a5cd7211bf80c4a22298e60b53384704
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M sys/include/color.h

  Log Message:
  -----------
  doc: fix doxygen warnings for color module

Also fixes the module name in API documentation.


  Commit: 481d4f2ee343423a1d55d70759cb87e467d9cb30
      https://github.com/RIOT-OS/RIOT/commit/481d4f2ee343423a1d55d70759cb87e467d9cb30
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M boards/arduino-due/include/board.h
    M boards/arduino-due/include/periph_conf.h
    M boards/avsextrem/include/board.h
    M boards/chronos/include/board.h
    M boards/iot-lab_M3/include/periph_conf.h
    M boards/mbed_lpc1768/include/board.h
    M boards/msb-430-common/include/board-conf.h
    M boards/msb-430/include/board.h
    M boards/msb-430h/include/board.h
    M boards/msba2/include/board.h
    M boards/native/include/board.h
    M boards/pca10000/include/board.h
    M boards/pca10000/include/periph_conf.h
    M boards/pca10005/include/board.h
    M boards/pca10005/include/periph_conf.h
    M boards/pttu/include/board.h
    M boards/redbee-econotag/include/board.h
    M boards/samr21-xpro/include/board.h
    M boards/samr21-xpro/include/periph_conf.h
    M boards/telosb/include/board.h
    M boards/udoo/include/board.h
    M boards/udoo/include/periph_conf.h
    M boards/wsn430-common/include/board-conf.h
    M boards/wsn430-v1_3b/include/board.h
    M boards/wsn430-v1_4/include/board.h
    M boards/yunjia-nrf51822/include/board.h
    M boards/yunjia-nrf51822/include/periph_conf.h
    M cpu/cortex-m3_common/include/cpu.h
    M cpu/nrf51822/include/cpu-conf.h
    M cpu/nrf51822/include/hwtimer_cpu.h
    M cpu/sam3x8e/include/cpu-conf.h
    M cpu/sam3x8e/include/hwtimer_cpu.h
    M cpu/samd21/include/cpu-conf.h
    M cpu/samd21/include/hwtimer_cpu.h
    M cpu/stm32f1/include/hwtimer_cpu.h

  Log Message:
  -----------
  doc: fix ambiguous file name warnings

doxygen does a good job itself, identifying the unique part of the path
to identify a file.


  Commit: ca866b248e83d686b5899cbb806d81741a2cd752
      https://github.com/RIOT-OS/RIOT/commit/ca866b248e83d686b5899cbb806d81741a2cd752
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/cortex-m3_common/doc.txt

  Log Message:
  -----------
  doc: fix naming for Cortex M3 common group


  Commit: bbf82ab2546c4511414bea2abd51d3cbfd1080a9
      https://github.com/RIOT-OS/RIOT/commit/bbf82ab2546c4511414bea2abd51d3cbfd1080a9
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/atmega_common/include/cpu.h

  Log Message:
  -----------
  doc: put atmega cpu file into the right group


  Commit: a9a5c2da1c5a0bb0a6072356085c30ac698e779f
      https://github.com/RIOT-OS/RIOT/commit/a9a5c2da1c5a0bb0a6072356085c30ac698e779f
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M sys/include/vtimer.h

  Log Message:
  -----------
  doc: fix vtimer documentation


  Commit: 31b83e8753e6af1746c36e9ff2d123c01c7db9ff
      https://github.com/RIOT-OS/RIOT/commit/31b83e8753e6af1746c36e9ff2d123c01c7db9ff
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M boards/iot-lab_M3/include/board.h

  Log Message:
  -----------
  doc: rename iot-lab_M3 group name


  Commit: 3092416a0afde90b3da6c6add7bb62330322255c
      https://github.com/RIOT-OS/RIOT/commit/3092416a0afde90b3da6c6add7bb62330322255c
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M boards/pca10000/include/board.h
    M boards/pca10005/include/board.h

  Log Message:
  -----------
  doc: add names to pca1000x boards


  Commit: b066433bdcb451d41ce4af362a084a8af1800068
      https://github.com/RIOT-OS/RIOT/commit/b066433bdcb451d41ce4af362a084a8af1800068
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M doc/doxygen/riot.doxyfile

  Log Message:
  -----------
  doc: improve doxygen cache size


  Commit: c0bcac460e1b5d0df08593ce4af41d21ae2a50a8
      https://github.com/RIOT-OS/RIOT/commit/c0bcac460e1b5d0df08593ce4af41d21ae2a50a8
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M doc/doxygen/riot.doxyfile
    A doc/doxygen/src/riot-logo.png
    A doc/doxygen/src/riot-logo.svg

  Log Message:
  -----------
  doc: beautify HTML documentation

* add logo
* add description
* use RIOT specific color scheme
* add search functionality
* remove broken custom header, footer, and style sheet


  Commit: c53bd9ca5d1816ee3418ab8d8cbac4a1563b48d6
      https://github.com/RIOT-OS/RIOT/commit/c53bd9ca5d1816ee3418ab8d8cbac4a1563b48d6
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/samd21/include/samd21.h
    M doc/doxygen/riot.doxyfile

  Log Message:
  -----------
  doc: remove more CPU specific documentation


  Commit: cb48f7cd47fefe7ea1d1700790b76a659116f5bd
      https://github.com/RIOT-OS/RIOT/commit/cb48f7cd47fefe7ea1d1700790b76a659116f5bd
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-23 (Thu, 23 Oct 2014)

  Changed paths:
    M cpu/atmega_common/avr-libc-extra/time.h

  Log Message:
  -----------
  doc: fix warning from avr libc


  Commit: c33e1b5dada72615165ac902874b5dae4bc84882
      https://github.com/RIOT-OS/RIOT/commit/c33e1b5dada72615165ac902874b5dae4bc84882
  Author: Oleg Hahm <oleg at hobbykeller.org>
  Date:   2014-10-24 (Fri, 24 Oct 2014)

  Changed paths:
    M boards/arduino-due/include/board.h
    M boards/arduino-due/include/periph_conf.h
    M boards/avsextrem/include/board.h
    M boards/chronos/include/board.h
    M boards/iot-lab_M3/include/board.h
    M boards/iot-lab_M3/include/periph_conf.h
    M boards/mbed_lpc1768/include/board.h
    M boards/msb-430-common/include/board-conf.h
    M boards/msb-430/include/board.h
    M boards/msb-430h/include/board.h
    M boards/msba2/include/board.h
    M boards/native/include/board.h
    M boards/pca10000/include/board.h
    M boards/pca10000/include/periph_conf.h
    M boards/pca10005/include/board.h
    M boards/pca10005/include/periph_conf.h
    M boards/pttu/include/board.h
    M boards/redbee-econotag/include/board.h
    M boards/samr21-xpro/include/board.h
    M boards/samr21-xpro/include/periph_conf.h
    M boards/telosb/include/board.h
    M boards/udoo/include/board.h
    M boards/udoo/include/periph_conf.h
    M boards/wsn430-common/include/board-conf.h
    M boards/wsn430-v1_3b/include/board.h
    M boards/wsn430-v1_4/include/board.h
    M boards/yunjia-nrf51822/include/board.h
    M boards/yunjia-nrf51822/include/periph_conf.h
    M core/include/arch/hwtimer_arch.h
    M core/include/byteorder.h
    M core/include/debug.h
    M core/include/hwtimer.h
    M core/include/kernel.h
    M core/include/kernel_internal.h
    M core/include/kernel_types.h
    M core/include/lifo.h
    M core/include/thread.h
    M cpu/atmega_common/avr-libc-extra/time.h
    M cpu/atmega_common/include/cpu.h
    M cpu/cortex-m3_common/doc.txt
    M cpu/cortex-m3_common/include/cpu.h
    M cpu/nrf51822/include/cpu-conf.h
    M cpu/nrf51822/include/hwtimer_cpu.h
    M cpu/nrf51822/include/nrf51.h
    M cpu/sam3x8e/include/cpu-conf.h
    M cpu/sam3x8e/include/hwtimer_cpu.h
    M cpu/samd21/include/cpu-conf.h
    M cpu/samd21/include/hwtimer_cpu.h
    M cpu/samd21/include/samd21.h
    M cpu/stm32f0/include/stm32f051x8.h
    M cpu/stm32f1/include/cpu-conf.h
    M cpu/stm32f1/include/hwtimer_cpu.h
    M cpu/stm32f1/include/stm32f10x.h
    M cpu/stm32f3/include/stm32f303xc.h
    M cpu/stm32f4/include/stm32f407xx.h
    M cpu/stm32f4/include/stm32f415xx.h
    M doc/doxygen/riot.doxyfile
    A doc/doxygen/src/riot-logo.png
    A doc/doxygen/src/riot-logo.svg
    M sys/crypto/doc.txt
    M sys/include/color.h
    M sys/include/vtimer.h
    M sys/oneway-malloc/include/malloc.h

  Log Message:
  -----------
  Merge pull request #1844 from OlegHahm/doxygen_cleanup

Doxygen cleanup


Compare: https://github.com/RIOT-OS/RIOT/compare/616ff64929d7...c33e1b5dada7


More information about the commits mailing list