mirror of https://github.com/nymea/nymea.git
fixed documentation warinings
parent
07e661c466
commit
a7ca7621d4
|
|
@ -41,6 +41,7 @@ Action::Action(const ActionTypeId &actionTypeId, const DeviceId &deviceId) :
|
|||
{
|
||||
}
|
||||
|
||||
/*! Construct a copy of an \a other Action. */
|
||||
Action::Action(const Action &other):
|
||||
m_id(other.id()),
|
||||
m_actionTypeId(other.actionTypeId()),
|
||||
|
|
@ -97,6 +98,7 @@ Param Action::param(const QString ¶mName) const
|
|||
return Param(QString());
|
||||
}
|
||||
|
||||
/*! Copy the data to an \l{Action} from an \a other action. */
|
||||
void Action::operator =(const Action &other)
|
||||
{
|
||||
m_id = other.id();
|
||||
|
|
|
|||
|
|
@ -40,8 +40,9 @@ Event::Event():
|
|||
}
|
||||
|
||||
/*! Constructs an Event reflecting the \l{Event} given by \a eventTypeId, associated with
|
||||
* the \l{Device} given by \a deviceId and the parameters given by \a params. The parameters must
|
||||
* match the description in the reflecting \l{Event}. */
|
||||
* the \l{Device} given by \a deviceId and the parameters given by \a params. The parameter \a isStateChangeEvent
|
||||
* specifies if the \l{Event} will be autogeneratet or not. The parameters must
|
||||
* match the description in the reflecting \l{Event}. */
|
||||
Event::Event(const EventTypeId &eventTypeId, const DeviceId &deviceId, const ParamList ¶ms, bool isStateChangeEvent):
|
||||
m_id(EventId::createEventId()),
|
||||
m_eventTypeId(eventTypeId),
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ bool StateDescriptor::operator ==(const State &state) const
|
|||
}
|
||||
|
||||
/*! Compare this StateDescriptor to the \l{State} given by \a state.
|
||||
* returns true if the given \a state does not match the definition of the StateDescriptor */
|
||||
* Returns true if the given \a state does not match the definition of the StateDescriptor */
|
||||
bool StateDescriptor::operator !=(const State &state) const
|
||||
{
|
||||
return !(operator==(state));
|
||||
|
|
|
|||
|
|
@ -29,6 +29,7 @@
|
|||
Currently only following device is supported:
|
||||
|
||||
\l{http://www.leynew.com/en/productview.asp?id=589}{http://www.leynew.com/en/productview.asp?id=589}
|
||||
|
||||
\l{http://image.en.09635.com/2012-8/15/RF-Controller-Aluminum-Version-LN-CON-RF20B-H-3CH-LV-316.jpg}{http://image.en.09635.com/2012-8/15/RF-Controller-Aluminum-Version-LN-CON-RF20B-H-3CH-LV-316.jpg}
|
||||
|
||||
\chapter Plugin properties
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@
|
|||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{www.unitec-elektro.de}{Unitec}
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.unitec-elektro.de}{Unitec}
|
||||
devices.
|
||||
|
||||
\chapter Plugin properties
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ GuhCore::RunningMode GuhCore::runningMode() const
|
|||
}
|
||||
|
||||
/*! Set the \a runningMode of this instance. */
|
||||
void GuhCore::setRunningMode(const GuhCore::RunningMode &runningMode)
|
||||
void GuhCore::setRunningMode(const RunningMode &runningMode)
|
||||
{
|
||||
m_runningMode = runningMode;
|
||||
}
|
||||
|
|
@ -406,6 +406,7 @@ void GuhCore::gotEvent(const Event &event)
|
|||
}
|
||||
}
|
||||
|
||||
/*! Return the instance of the log engine */
|
||||
LogEngine* GuhCore::logEngine() const
|
||||
{
|
||||
return m_logger;
|
||||
|
|
|
|||
|
|
@ -103,6 +103,7 @@ void Rule::setEnabled(bool enabled)
|
|||
m_enabled = enabled;
|
||||
}
|
||||
|
||||
/*! Returns true if the rule is active. */
|
||||
bool Rule::active() const
|
||||
{
|
||||
return m_active;
|
||||
|
|
|
|||
Loading…
Reference in New Issue