Author: keith Date: Sat Jul 12 03:40:11 2008 New Revision: 19165 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19165
Log: Adding more documentation Modified: trunk/mashup/java/modules/hostobjects/src/org/wso2/mashup/hostobjects/system/SystemHostObject.java Modified: trunk/mashup/java/modules/hostobjects/src/org/wso2/mashup/hostobjects/system/SystemHostObject.java URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/modules/hostobjects/src/org/wso2/mashup/hostobjects/system/SystemHostObject.java?rev=19165&r1=19164&r2=19165&view=diff ============================================================================== --- trunk/mashup/java/modules/hostobjects/src/org/wso2/mashup/hostobjects/system/SystemHostObject.java (original) +++ trunk/mashup/java/modules/hostobjects/src/org/wso2/mashup/hostobjects/system/SystemHostObject.java Sat Jul 12 03:40:11 2008 @@ -103,7 +103,7 @@ * system.wait(1000); * </pre> * - * @throws MashupFault + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_wait(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -136,6 +136,8 @@ * <pre> * var hostname = system.localHostName; * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public String jsGet_localHostName() throws MashupFault { try { @@ -153,6 +155,8 @@ * <pre> * var endpointURL = system.endpointURL; * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public String jsGet_endpointURL() throws MashupFault { Object object = Context.getCurrentContext() @@ -185,6 +189,8 @@ * system.include("version?stub&lang=e4x", "lib2.js"); * system.include("http://tempuri.org/js/temp.js"); * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_include(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -358,6 +364,8 @@ * or * var id = system.setInterval('myJavaScriptFunction("I am a parameter value");', 2000, null, startTime, endtime); * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public static String jsFunction_setInterval(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -679,6 +687,8 @@ * <pre> * system.clearInterval(id); * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_clearInterval(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -704,6 +714,8 @@ * system.notifyMonitor("Title", "Message"); * system.notifyMonitor("Title", "Message", 3); * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_notifyMonitor(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -744,6 +756,8 @@ * <pre> * var history = system.getXML('http://wso2.org/repos/wso2/trunk/mashup/java/modules/samples/upgradeChecker/upgradeChecker.resources/history.xml'); * </pre> + * + * @throws MashupFault Thrown in case any exceptions occur */ public static Object jsFunction_getXML(Context context, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -792,6 +806,8 @@ * where expression is the JavaScript code to run after timeout milliseconds have elapsed. * <p/> * setTimeout() also returns a numeric timeout ID that can be used to track the timeout. This is most commonly used with the clearTimeout() method + * + * @throws MashupFault Thrown in case any exceptions occur */ public static String jsFunction_setTimeout(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -874,6 +890,8 @@ * <p/> * <p/> * where timeoutId is the ID of the timeout as returned from the setTimeout() method call. + * + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_clearTimeout(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { @@ -919,6 +937,8 @@ * <p/> * Where logmessage contains a string to be written to the system log and (optional) loglevel indicates the logging level as * 'info', 'warn', 'debug', 'error' or 'fatal'. The logging level defaults to 'info' when one is not provided. + * + * @throws MashupFault Thrown in case any exceptions occur */ public static void jsFunction_log(Context cx, Scriptable thisObj, Object[] arguments, Function funObj) throws MashupFault { _______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
