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

Timestamp:

03/15/13 12:21:58 (12 years ago)

Author:

tbretz

Message:

Added more examples for get()

File:

• trunk/FACT++/scripts/doc/Subscription.js (modified) (1 diff)

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

@@ -114 +114 @@
      *     timeout.
      *
+     * @example
+     *     var a = new Subscription("...service does not exist...");
+     *     a.get( 3000, true);  // throws an exception
+     *     a.get( 3000, false); // throws and exception
+     *     a.get(-3000, true);  // returns undefined
+     *     a.get(-3000, false); // returns undefined
+     *
+     *     var a = new Subscription("...service with valid description but no valid data yet...");
+     *     a.get( 3000, true);  // throws an exception
+     *     a.get( 3000, false); // returns Event.data==null, Event.obj valid but empty
+     *     a.get(-3000, true);  // return undefined
+     *     a.get(-3000, false); // returns Event.data==null, Event.obj valid but emoty
+     *
+     *     // Assuming that now valid description is available but data
+     *     var a = new Subscription("...service without valid description but valid data...");
+     *     a.get( 3000, true);  // throws an exception
+     *     a.get( 3000, false); // returns Event.data valid, Event.obj==undefined
+     *     a.get(-3000, true);  // returns undefined
+     *     a.get(-3000, false); // returns Event.data valid, Event.obj==undefined
+     *
      */
     this.get = function() { /* [native code] */ }