Navigation Menu

Skip to content

Commit

Permalink
[documentation] Fix hiccups in documentation comments. MER#1749
Browse files Browse the repository at this point in the history
There are build time warnings due to conflicts between actual source code
and documentation statements in the comments.

Use the actual filenames, correct case for parameters, etc.

Signed-off-by: Simo Piiroinen <simo.piiroinen@jollamobile.com>
  • Loading branch information
spiiroin committed Feb 7, 2017
1 parent 51e1528 commit 962e540
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
@@ -1,5 +1,5 @@
/**
@file magnetometeradaptor-evdevplugin.cpp
@file magnetometerevdevadaptor.h
@brief Contains MagnetometerAdaptorEvdevPlugin.
<p>
Expand Down
8 changes: 4 additions & 4 deletions datatypes/lid.h
Expand Up @@ -49,14 +49,14 @@ class Lid : public QObject
/**
* Constructor.
*
* @param LidData Source object.
* @param lidData Source object.
*/
Lid(const LidData& lidData);

/**
* Copy constructor.
*
* @param Lid Source object.
* @param lid Source object.
*/
Lid(const Lid& lid);

Expand Down Expand Up @@ -86,7 +86,7 @@ Q_DECLARE_METATYPE( Lid )
* Marshall the Lid data into a D-Bus argument
*
* @param argument dbus argument.
* @param Lid data to marshall.
* @param lid data to marshall.
* @return dbus argument.
*/
inline QDBusArgument &operator<<(QDBusArgument &argument, const Lid &lid)
Expand All @@ -101,7 +101,7 @@ inline QDBusArgument &operator<<(QDBusArgument &argument, const Lid &lid)
* Unmarshall Lid data from the D-Bus argument
*
* @param argument dbus argument.
* @param Lid unmarshalled data.
* @param lid unmarshalled data.
* @return dbus argument.
*/
inline const QDBusArgument &operator>>(const QDBusArgument &argument, Lid &lid)
Expand Down
3 changes: 2 additions & 1 deletion datatypes/liddata.h
@@ -1,5 +1,5 @@
/**
@file LidData.h
@file liddata.h
@brief Datatype for device tap events
<p>
Expand Down Expand Up @@ -57,6 +57,7 @@ class LidData : public TimedData {
* Constructor.
* @param timestamp Timestamp of lid event.
* @param type Type of lid.
* @param value Initial value to use
*/
LidData(const quint64& timestamp, Type type, unsigned value) :
TimedData(timestamp), type_(type), value_(value) {}
Expand Down

0 comments on commit 962e540

Please sign in to comment.