Parcourir la source

Added documentation about exceptions

Sascha Zelzer il y a 13 ans
Parent
commit
b8b2062bad
1 fichiers modifiés avec 5 ajouts et 0 suppressions
  1. 5 0
      Libs/PluginFramework/service/event/ctkEventAdmin.h

+ 5 - 0
Libs/PluginFramework/service/event/ctkEventAdmin.h

@@ -76,12 +76,17 @@ struct ctkEventAdmin
    * it under multiple topics. In that case, emitting the signal will result in
    * multiple events being send.
    *
+   * If the <code>topic</code> string is empty, a <code>std::invalid_argument</code>
+   * exception will be thrown.
+   *
    * @param publisher The owner of the signal.
    * @param signal The signal in normalized form.
    * @param topic The event topic to use.
    * @param type Qt::QueuedConnection for asynchronous delivery and
    *        Qt::DirectConnection for synchronous delivery.
    *
+   * @throws std::invalid_argument If <code>topic</code> is empty.
+   *
    * @see unpublishSignal()
    */
   virtual void publishSignal(const QObject* publisher, const char* signal,