Changeset 14873 for trunk/FACT++/scripts/doc/Subscription.js

Timestamp:

02/05/13 16:20:46 (12 years ago)

Author:

tbretz

Message:

Updated, fixed some docs (typos, wrong text)

File:

• trunk/FACT++/scripts/doc/Subscription.js (modified) (2 diffs)

trunk/FACT++/scripts/doc/Subscription.js

@@ -91 +91 @@
      *     This timeout only applied if no event has been received yet
      *     after a new Subscription has been created. If an event
-     *     is already available, the event is received. If the timeout
-     *     is 'null', waiting will nevr timeout until an event was received.
+     *     is already available, the event is returned. If the timeout
+     *     is 'null', waiting will never timeout until an event was received.
      *     If the timeout is less than zero, no exception will be thrown,
      *     but 'undefined' returned in case of timeout. The corresponding
@@ -99 +99 @@
      * @param {Boolean} [requireNamed=true]
      *     Usually an event is only considered complete, if also the
-     *     corresponding decription is available distcibuted through
+     *     corresponding decription is available distributed through
      *     the service SERVER/SERVICE_DESC. If an event has no
-     *     subscription or it is not important, requireNamed can
-     *     be set to false.
+     *     description or access to the data by name is not important,
+     *     requireNamed can be set to false.
      *
      * @throws
      *    <li> If number or type of arguments is wrong
      *    <li> After a timeout, if the timeout value was greater or equal zero
-     *    <li> If conversion of th received data to an event object has failed
+     *    <li> If conversion of the received data to an event object has failed
      *
      * @returns {Event}
-     *     If the thread was still known, true is returned, false
-     *     otherwise. If the thread terminated already, false is
-     *     returned.
+     *     A valid event is returned, undefined in the case waiting for an
+     *     event has timed out and exceptions are supressed by a negative
+     *     timeout.
      *
      */