Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix up documentation a bit.
  • Loading branch information
lpotter committed Jan 22, 2015
1 parent 6854c99 commit 75ec3aa
Show file tree
Hide file tree
Showing 22 changed files with 770 additions and 29 deletions.
8 changes: 8 additions & 0 deletions adaptors/hybrisaccelerometer/hybrisaccelerometeradaptor.h
Expand Up @@ -28,6 +28,14 @@
#include "deviceadaptorringbuffer.h"
#include "datatypes/orientationdata.h"

/**
* @brief Adaptor for hybris accelerometer.
*
* Adaptor for internal accelerometer. Uses hybris sensor daemon driver interface in interval
* polling mode, i.e. values are read with given constant interval.
*
*
*/
class HybrisAccelerometerAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
10 changes: 10 additions & 0 deletions adaptors/hybrisalsadaptor/hybrisalsadaptor.h
Expand Up @@ -29,6 +29,16 @@
#include "datatypes/orientationdata.h"
#include <QTime>

/**
* @brief Adaptor for hybris ambient light sensor.
*
* Adaptor for internal light sensor. Provides the amount of ambient
* light detected by the device. Uses hybris sensor daemon driver interface.
*
* Value output frequency depends on driver decision - only changed values
* are pushed out of driver.
*
*/
class HybrisAlsAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
7 changes: 7 additions & 0 deletions adaptors/hybrisgyroscopeadaptor/hybrisgyroscopeadaptor.h
Expand Up @@ -29,6 +29,13 @@
#include "datatypes/orientationdata.h"
#include <QTime>

/**
* @brief Adaptor for hybris gyroscope.
*
* Adaptor for internal gyroscope. Uses hybris sensor daemon driver interface in
* polling mode, i.e. values are read with given constant interval.
*
*/
class HybrisGyroscopeAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
Expand Up @@ -29,6 +29,13 @@
#include "datatypes/orientationdata.h"
#include <QTime>

/**
* @brief Adaptor for hybris magnetometer.
*
* Adaptor for internal magnetometer
* Uses hybris sensor daemon driver interface in interval
* polling mode, i.e. values are read with given constant interval.
*/
class HybrisMagnetometerAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
7 changes: 7 additions & 0 deletions adaptors/hybrisorientationadaptor/hybrisorientationadaptor.h
Expand Up @@ -27,6 +27,13 @@
#include "deviceadaptorringbuffer.h"
#include "datatypes/orientationdata.h"

/**
* @brief Adaptor for hybris compass.
*
* Adaptor for internal compass
* Uses hybris sensor daemon driver interface in interval
* polling mode, i.e. values are read with given constant interval.
*/
class HybrisOrientationAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
9 changes: 9 additions & 0 deletions adaptors/hybrisproximityadaptor/hybrisproximityadaptor.h
Expand Up @@ -29,6 +29,15 @@
#include "datatypes/orientationdata.h"
#include <QTime>


/**
* @brief Adaptor for hybris proximity sensor.
*
* Adaptor for proximity. Uses hybris sensor daemon driver interface.
*
* Value output frequency depends on driver decision - only changed values
* are pushed out of driver.
*/
class HybrisProximityAdaptor : public HybrisAdaptor
{
Q_OBJECT
Expand Down
2 changes: 1 addition & 1 deletion chains/accelerometerchain/accelerometerchain.h
Expand Up @@ -41,7 +41,7 @@ class FilterBase;
* aligned to Nokia Standard Coordinate system.
*
* <b>Output buffers:</b>
* <ul><li>\em accelerometer</li></ul>
* <ul><li><em>accelerometer</em></li></ul>
*
* For direct raw data (no coordinate correction) use #AccelerometerAdaptor.
*/
Expand Down
2 changes: 2 additions & 0 deletions core/abstractsensor_a.h
Expand Up @@ -34,6 +34,8 @@
#include "datatypes/datarange.h"

/**
* @brief D-Bus adaptor base class for sensors
*
* Sensor DBus facade for handling remote method invocations. It instance
* has associated AbstractSensorChannel to which this object delegates
* calls.
Expand Down
2 changes: 1 addition & 1 deletion datatypes/magneticfield.h
Expand Up @@ -32,7 +32,7 @@
#include <datatypes/orientationdata.h>

/**
* QObject facade for #CalibratedMagneticField.
* QObject facade for #CalibratedMagneticFieldData.
*/
class MagneticField : public QObject
{
Expand Down
4 changes: 2 additions & 2 deletions datatypes/xyz.h
Expand Up @@ -31,7 +31,7 @@
#include <datatypes/orientationdata.h>

/**
* QObject facade for #TimedXYZData.
* QObject facade for #XYZData.
*/
class XYZ : public QObject
{
Expand Down Expand Up @@ -63,7 +63,7 @@ class XYZ : public QObject
XYZ(const XYZ& xyz);

/**
* Returns the contained #TimedXYZData
* Returns the contained #XYZData
* @return Contained TimedXYZData
*/
const TimedXyzData& XYZData() const { return data_; }
Expand Down
2 changes: 1 addition & 1 deletion doc/Doxyfile
Expand Up @@ -874,7 +874,7 @@ BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the HTML help documentation and to the tree view.

TOC_EXPAND = NO
TOC_EXPAND = YES

# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
# are set, an additional index file will be generated that can be used as input for
Expand Down
1 change: 0 additions & 1 deletion doc/doc.pri
Expand Up @@ -11,7 +11,6 @@ contains(MAKE_DOCS,no): {
doctarget.commands = echo \"*** skip building docs ***\"
} else {
doctarget.commands = INPUT=\"$${_PRO_FILE_PWD_}/adaptors \
$${_PRO_FILE_PWD_}/adaptors/arianeadaptor \
$${_PRO_FILE_PWD_}/datatypes \
$${_PRO_FILE_PWD_}/sensord \
$${_PRO_FILE_PWD_}/filters \
Expand Down

0 comments on commit 75ec3aa

Please sign in to comment.