Skip to content

Commit

Permalink
Add tags to our code
Browse files Browse the repository at this point in the history
  • Loading branch information
theotherjimmy committed Oct 4, 2016
1 parent 2cea844 commit f1a7802
Show file tree
Hide file tree
Showing 144 changed files with 663 additions and 0 deletions.
4 changes: 4 additions & 0 deletions drivers/AnalogIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An analog input, used for reading the voltage on a pin
*
Expand Down Expand Up @@ -126,3 +128,5 @@ class AnalogIn {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/AnalogOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An analog output, used for setting the voltage on a pin
*
Expand Down Expand Up @@ -144,3 +146,5 @@ class AnalogOut {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/BusIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital input bus, used for reading the state of a collection of pins
*
Expand Down Expand Up @@ -102,3 +104,5 @@ class BusIn {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/BusInOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital input output bus, used for setting the state of a collection of pins
*
Expand Down Expand Up @@ -121,3 +123,5 @@ class BusInOut {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/BusOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital output bus, used for setting the state of a collection of pins
*/
Expand Down Expand Up @@ -105,3 +107,5 @@ class BusOut {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/CAN.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** CANMessage class
*
Expand Down Expand Up @@ -256,3 +258,5 @@ class CAN {
#endif

#endif // MBED_CAN_H

/** @}*/
4 changes: 4 additions & 0 deletions drivers/DigitalIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
#include "platform/critical.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital input, used for reading the state of a pin
*
Expand Down Expand Up @@ -113,3 +115,5 @@ class DigitalIn {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/DigitalInOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
#include "platform/critical.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital input/output, used for setting or reading a bi-directional pin
*
Expand Down Expand Up @@ -138,3 +140,5 @@ class DigitalInOut {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/DigitalOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#include "platform/critical.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital output, used for setting the state of a pin
*
Expand Down Expand Up @@ -124,3 +126,5 @@ class DigitalOut {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/DirHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ struct dirent {
};

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** Represents a directory stream. Objects of this type are returned
* by a FileSystemLike's opendir method. Implementations must define
Expand Down Expand Up @@ -118,3 +120,5 @@ extern "C" {
};

#endif /* MBED_DIRHANDLE_H */

/** @}*/
4 changes: 4 additions & 0 deletions drivers/Ethernet.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
#if DEVICE_ETHERNET

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An ethernet interface, to use with the ethernet pins.
*
Expand Down Expand Up @@ -170,3 +172,5 @@ class Ethernet {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/FileBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ typedef long off_t;
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

typedef enum {
FilePathType,
Expand Down Expand Up @@ -80,3 +82,5 @@ class FileBase {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/FileHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ typedef long off_t;
#endif

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An OO equivalent of the internal FILEHANDLE variable
* and associated _sys_* functions.
Expand Down Expand Up @@ -138,3 +140,5 @@ class FileHandle {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/FileLike.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
#include "drivers/FileHandle.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/* Class FileLike
* A file-like object is one that can be opened with fopen by
Expand All @@ -45,3 +47,5 @@ class FileLike : public FileHandle, public FileBase {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/FilePath.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
#include "drivers/FileLike.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

class FilePath {
public:
Expand All @@ -44,3 +46,5 @@ class FilePath {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/FileSystemLike.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#include "drivers/DirHandle.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A filesystem-like object is one that can be used to open files
* though it by fopen("/name/filename", mode)
Expand Down Expand Up @@ -104,3 +106,5 @@ class FileSystemLike : public FileBase {
} // namespace mbed

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/I2C.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
#endif

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An I2C Master, used for communicating with I2C slave devices
*
Expand Down Expand Up @@ -191,3 +193,5 @@ class I2C {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/I2CSlave.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#include "hal/i2c_api.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** An I2C Slave, used for communicating with an I2C Master device
*
Expand Down Expand Up @@ -154,3 +156,5 @@ class I2CSlave {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/InterruptIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
#include "platform/toolchain.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A digital interrupt input, used to call a function on a rising or falling edge
*
Expand Down Expand Up @@ -158,3 +160,5 @@ class InterruptIn {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/InterruptManager.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
#include <string.h>

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** Use this singleton if you need to chain interrupt handlers.
*
Expand Down Expand Up @@ -169,3 +171,5 @@ class InterruptManager {

#endif


/** @}*/
4 changes: 4 additions & 0 deletions drivers/LocalFileSystem.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "platform/PlatformMutex.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

FILEHANDLE local_file_open(const char* name, int flags);

Expand Down Expand Up @@ -108,3 +110,5 @@ class LocalFileSystem : public FileSystemLike {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/LowPowerTicker.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "hal/lp_ticker_api.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** Low Power Ticker
*
Expand All @@ -44,3 +46,5 @@ class LowPowerTicker : public Ticker {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/LowPowerTimeout.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "drivers/LowPowerTicker.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** Low Power Timout
*
Expand All @@ -42,3 +44,5 @@ class LowPowerTimeout : public LowPowerTicker {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/LowPowerTimer.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "hal/lp_ticker_api.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** Low power timer
*
Expand All @@ -42,3 +44,5 @@ class LowPowerTimer : public Timer {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/PortIn.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "platform/critical.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A multiple pin digital input
*
Expand Down Expand Up @@ -98,3 +100,5 @@ class PortIn {
#endif

#endif

/** @}*/
4 changes: 4 additions & 0 deletions drivers/PortInOut.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
#include "platform/critical.h"

namespace mbed {
/** \addtogroup drivers */
/** @{*/

/** A multiple pin digital in/out used to set/read multiple bi-directional pins
*
Expand Down Expand Up @@ -113,3 +115,5 @@ class PortInOut {
#endif

#endif

/** @}*/
Loading

0 comments on commit f1a7802

Please sign in to comment.