Skip to content

Commit

Permalink
[docs] Refactor modm/platform doxygen groups
Browse files Browse the repository at this point in the history
  • Loading branch information
salkinium committed Oct 15, 2018
1 parent 5ae741f commit 47b4126
Show file tree
Hide file tree
Showing 126 changed files with 256 additions and 278 deletions.
2 changes: 1 addition & 1 deletion src/modm/platform/adc/at90_tiny_mega/adc_interrupt.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace platform
/**
* @author Niklas Hauser
*
* @ingroup {{partname}}_adc
* @ingroup modm_platform_adc
*/
class AdcInterrupt : public modm::platform::Adc, public modm::AdcInterrupt
{
Expand Down
7 changes: 1 addition & 6 deletions src/modm/platform/adc/at90_tiny_mega/adc_mega.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@
*/
// ----------------------------------------------------------------------------

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_adc ADC
*/

#ifndef MODM_ATMEGA_ADC_HPP
#define MODM_ATMEGA_ADC_HPP

Expand Down Expand Up @@ -69,7 +64,7 @@ namespace platform
* needed the frequency can be higher.
*
* @author Niklas Hauser
* @ingroup {{partname}}_adc
* @ingroup modm_platform_adc
*/
class Adc : public modm::Adc
{
Expand Down
7 changes: 1 addition & 6 deletions src/modm/platform/adc/at90_tiny_mega/adc_tiny.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@
*/
// ----------------------------------------------------------------------------

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_adc ADC
*/

#ifndef MODM_ATTINY_ADC_HPP
#define MODM_ATTINY_ADC_HPP

Expand Down Expand Up @@ -105,7 +100,7 @@ namespace platform
* needed the frequency can be higher.
*
* @author Niklas Hauser
* @ingroup {{partname}}_adc
* @ingroup modm_platform_adc
*/
class Adc : public modm::Adc
{
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/adc/at90_tiny_mega/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = "adc"
module.parent = "platform"
module.description = "Analog-to-Digital Converter (ADC)"

def prepare(module, options):
device = options[":target"]
Expand Down
7 changes: 1 addition & 6 deletions src/modm/platform/adc/stm32/adc.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
#include <modm/architecture/interface/register.hpp>
#include <modm/platform/gpio/connector.hpp>

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_adc ADC
*/

namespace modm
{

Expand All @@ -43,7 +38,7 @@ namespace platform
* @author Stephan Kugelmann
* @author David Hebbeker
* @author ekiwi
* @ingroup {{partname}}_adc
* @ingroup modm_platform_adc modm_platform_adc_{{id}}
*/
class Adc{{ id }} : public modm::Adc
{
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/adc/stm32/adc_interrupt.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace platform
*
* @see AnalogSensors uses this implemenation.
*
* @ingroup {{partname}}_adc
* @ingroup modm_platform_adc_{{id}}
* @author Niklas Hauser
*/
class AdcInterrupt{{ id }} : public Adc{{ id }}, public modm::AdcInterrupt
Expand Down
3 changes: 2 additions & 1 deletion src/modm/platform/adc/stm32/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class Instance(Module):

def init(self, module):
module.name = str(self.instance)
module.description = "ADC {} instance".format(self.instance)
module.description = "Instance {}".format(self.instance)

def prepare(self, module, options):
module.depends(":platform:adc")
Expand Down Expand Up @@ -64,6 +64,7 @@ class Instance(Module):
def init(module):
module.name = "adc"
module.parent = "platform"
module.description = "Analog-to-Digital Converter (ADC)"

def prepare(module, options):
device = options[":target"]
Expand Down
7 changes: 2 additions & 5 deletions src/modm/platform/adc/stm32f0/adc.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
#include "../../../device.hpp"
#include <modm/architecture/interface/register.hpp>

/**
* @ingroup {{target.string}}
* @defgroup {{target.string}}_adc ADC
*/

namespace modm
{
namespace stm32
Expand All @@ -39,7 +36,7 @@ namespace stm32
* This API is designed for the internal ADCs of STM32F0x1/STM32F0x2/STM32F0x8
*
* \author Álan Crístoffer
* \ingroup {{target.string}}_adc
* \ingroup modm_platform_adc
*/
class Adc
{
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/adc/stm32f3/adc.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ namespace platform
*
* \author Kevin Laeufer
* \author Sascha Schade (strongly-typed)
* \ingroup stm32
* \ingroup modm_platform_adc modm_platform_adc_{{id}}
*/
class Adc{{ id }}
{
Expand Down
3 changes: 2 additions & 1 deletion src/modm/platform/adc/stm32f3/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class Instance(Module):

def init(self, module):
module.name = str(self.instance)
module.description = "ADC {} instance".format(self.instance)
module.description = "Instance {}".format(self.instance)

def prepare(self, module, options):
module.depends(":platform:adc")
Expand Down Expand Up @@ -96,6 +96,7 @@ class Instance(Module):
def init(module):
module.name = "adc"
module.parent = "platform"
module.description = "Analog-to-Digital Converter (ADC)"

def prepare(module, options):
device = options[":target"]
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/can/canusb/canusb.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ namespace platform
*
* @see http://www.canusb.com/
* @see http://www.can232.com/
* @ingroup hosted
* @ingroup modm_platform_canusb
*/
template <typename SerialPort>
class CanUsb : public ::modm::Can
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/can/canusb/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
def init(module):
module.name = "canusb"
module.parent = "platform"
module.description = "CANUSB Driver"


def prepare(module, options):
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/can/common/can_bit_timings.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ namespace modm
*
*
* @author Kevin Laeufer
* @ingroup can
* @ingroup modm_platform_can_common
*/
template<int32_t Clk, int32_t Bitrate>
class CanBitTiming
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/can/common/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = "can.common"
module.parent = "platform"
module.description = "CAN Common"

def prepare(module, options):
module.depends(":architecture:clock")
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/can/socketcan/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = "socketcan"
module.parent = "platform"
module.description = "SocketCAN"

def prepare(module, options):
if not options[":target"].has_driver("can:socketcan"):
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/can/socketcan/socketcan.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace modm
namespace platform
{

/// @ingroup modm_platform_socketcan
class SocketCan : public ::modm::Can
{
public:
Expand Down
7 changes: 1 addition & 6 deletions src/modm/platform/can/stm32/can.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@

using namespace modm::clock; // for MHzxx

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_can CAN
*/

namespace modm
{

Expand All @@ -57,7 +52,7 @@ namespace platform
* You can set the buffer size using the `tx_buffer` and `rx_buffer` parameters.
*
* @author Fabian Greif <[email protected]>
* @ingroup {{partname}}_can
* @ingroup modm_platform_can{% if id | length %} modm_platform_can_{{id}}{% endif %}
*/
class Can{{ id }} : public ::modm::Can
{
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/can/stm32/can_filter.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace platform
* @brief Filters for the Basic Extended CAN Module
*
* @author Fabian Greif <[email protected]>
* @ingroup {{partname}}_can
* @ingroup modm_platform_can
*/
class CanFilter
{
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/can/stm32/error_code.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace modm
{
namespace platform
{
/// @ingroup {{partname}}_can
/// @ingroup modm_platform_can
enum ErrorCode
{
CAN_ERROR_PASSIVE_MODE = 0x0010,
Expand Down
3 changes: 2 additions & 1 deletion src/modm/platform/can/stm32/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class Instance(Module):

def init(self, module):
module.name = str(self.instance)
module.description = "CAN {} instance".format(self.instance)
module.description = "Instance {}".format(self.instance)

def prepare(self, module, options):
load_options(module)
Expand All @@ -127,6 +127,7 @@ class Instance(Module):
def init(module):
module.name = "can"
module.parent = "platform"
module.description = "Controller Area Network (CAN)"

def prepare(module, options):
device = options[":target"]
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/clock/avr/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = "clock"
module.parent = "platform"
module.description = "System Clock"

def prepare(module, options):
if not options[":target"].has_driver("clock:avr"):
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/clock/avr/static.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ namespace modm
namespace platform
{

/// @ingroup avr
/// @ingroup modm_platform_clock
class
SystemClock
{
Expand Down
3 changes: 3 additions & 0 deletions src/modm/platform/clock/common/common_clock.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace clock

/**
* Errors that might prevent using a certain clock configuration
* @ingroup modm_platform_clock
*/
enum class
StartupError : uint8_t
Expand All @@ -41,10 +42,12 @@ StartupError : uint8_t
WatchdogClock
};

/// @cond
extern uint32_t modm_fastdata fcpu;
extern uint32_t modm_fastdata fcpu_kHz;
extern uint16_t modm_fastdata fcpu_MHz;
extern uint16_t modm_fastdata ns_per_loop;
/// @endcond

} // namespace clock

Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/clock/cortex/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import os
def init(module):
module.parent = "platform"
module.name = "clock.cortex"
module.description = "ARM Cortex-M SysTick"

def prepare(module, options):
if not options[":target"].has_driver("core:cortex-m*"):
Expand Down
2 changes: 1 addition & 1 deletion src/modm/platform/clock/cortex/systick_timer.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ typedef void (*InterruptHandler)(void);

/**
* @brief SysTick Timer
* @ingroup cortex
* @ingroup modm_platform_clock_cortex
*/
class SysTickTimer
{
Expand Down
7 changes: 1 addition & 6 deletions src/modm/platform/clock/stm32/clock.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@
#ifndef MODM_STM32_CLOCK_HPP
#define MODM_STM32_CLOCK_HPP

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_clock System Clock
*/

#include <stdint.h>
#include "../device.hpp"
#include "common_clock.hpp"
Expand All @@ -42,7 +37,7 @@ namespace platform
* Don't forget to set the flash latencies.
*
* @author Niklas Hauser
* @ingroup {{partname}}_clock
* @ingroup modm_platform_clock
*/
class ClockControl
{
Expand Down
1 change: 1 addition & 0 deletions src/modm/platform/clock/stm32/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
def init(module):
module.name = "clock"
module.parent = "platform"
module.description = "Reset and Clock Control (RCC)"

def prepare(module, options):
if not options[":target"].has_driver("rcc:stm32*"):
Expand Down
6 changes: 2 additions & 4 deletions src/modm/platform/comp/stm32/base.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@
#ifndef MODM_STM32_COMP_BASE_HPP
#define MODM_STM32_COMP_BASE_HPP

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_comp Comparator
*/

namespace modm::platform
{
/// @ingroup modm_platform_comp
class CompBase
{
public:
Expand Down
8 changes: 1 addition & 7 deletions src/modm/platform/comp/stm32/comp.hpp.in
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,13 @@

#include <modm/platform/gpio/connector.hpp>

/**
* @ingroup {{partname}}
* @defgroup {{partname}}_comp Comparator
*/


namespace modm::platform
{
/**
* @brief Comparator Class for STM32
*
* @internal
* @ingroup {{partname}}_comp
* @ingroup modm_platform_comp modm_platform_comp_{{id}}
*/
class Comp{{ id }} : public CompBase
{
Expand Down
3 changes: 2 additions & 1 deletion src/modm/platform/comp/stm32/module.lb
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Instance(Module):

def init(self, module):
module.name = str(self.instance)
module.description = "COMP {} instance".format(self.instance)
module.description = "Instance {}".format(self.instance)

def prepare(self, module, options):
module.depends(":platform:comp")
Expand All @@ -41,6 +41,7 @@ class Instance(Module):
def init(module):
module.name = "comp"
module.parent = "platform"
module.description = "Comparator (COMP)"

def prepare(module, options):
device = options[":target"]
Expand Down
Loading

0 comments on commit 47b4126

Please sign in to comment.