Changeset 8694

Show
Ignore:
Timestamp:
12/10/07 12:55:38 (3 years ago)
Author:
zumbrunn
Message:

removed spaces prefixing example code which were needed with the perl based jsdoc but get in the way with jsdoc-toolkit

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • apps/reference/trunk/coreEnvironment/DatabaseObject.js

    r8653 r8694  
    3535 * <br /><br /> 
    3636 * Example: 
    37  * <pre> var dbConnection = getDBConnection("db_source_name"); 
     37 * <pre>var dbConnection = getDBConnection("db_source_name"); 
    3838 * &nbsp; 
    3939 * var dbRowset = dbConnection.executeRetrieval("select title from dummy"); 
  • apps/reference/trunk/coreEnvironment/HopObject.js

    r8689 r8694  
    8181 * <br /><br /> 
    8282 * Example: 
    83  * <pre> var obj = root.get(0); 
     83 * <pre>var obj = root.get(0); 
    8484 * obj.cache.message = "This is a temporary message."</pre> 
    8585 *  
     
    154154 * <br /><br /> 
    155155 * Example: 
    156  * <pre> res.write(root.count()); 
     156 * <pre>res.write(root.count()); 
    157157 * <i>5</i></pre> 
    158158 *  
     
    190190 * <br /><br /> 
    191191 * Example: 
    192  * <pre> root.get(0); 
     192 * <pre>root.get(0); 
    193193 * HopObject author 
    194194 * root.get(1); 
     
    235235 * <br /><br /> 
    236236 * Example: 
    237  * <pre> //get the child with id 17 
     237 * <pre>//get the child with id 17 
    238238 * var child = root.getById(17); 
    239239 * writeln(child._id); 
     
    288288 * <br /><br /> 
    289289 * Example: 
    290  * <pre> var orderedByDate = hobj.getOrderedView("createtime desc, name"); 
     290 * <pre>var orderedByDate = hobj.getOrderedView("createtime desc, name"); 
    291291 * var collection = orderedByDate.list(); 
    292292 * for (var i in collection) { 
     
    315315 * <br /><br /> 
    316316 * Example: 
    317  * <pre> root.getResource("main.skin"); 
     317 * <pre>root.getResource("main.skin"); 
    318318 * /usr/local/helma-apps/myApp/repository1/HopObject/main.skin 
    319319 * root.getResource("type.properties"); 
     
    358358 * <br /><br /> 
    359359 * Example: 
    360  * <pre> var obj = root.get(0); 
     360 * <pre>var obj = root.get(0); 
    361361 * &nbsp; 
    362362 * res.write('&lt;a href="' + obj.href() + '"&gt;'); 
     
    386386 * <br /><br /> 
    387387 * Example: 
    388  * <pre> var obj = this.get(0); 
     388 * <pre>var obj = this.get(0); 
    389389 * obj.invalidate();</pre> 
    390390 *  
     
    406406 * <br /><br /> 
    407407 * Example: 
    408  * <pre> var obj = root.get("myObject"); 
     408 * <pre>var obj = root.get("myObject"); 
    409409 * res.write(root.indexOf(obj)); 
    410410 * <i>23</i> 
     
    434434 * <br /><br /> 
    435435 * Example: 
    436  * <pre> var objectList = root.list(); 
     436 * <pre>var objectList = root.list(); 
    437437 * for (var i=0; i &lt; objectList.length; i++){ 
    438438 * &nbsp;&nbsp;var myObject = objectList[i]; 
     
    455455 * the subnode collection using the get() function. 
    456456 * <br /><br /> 
    457  * <pre> var amount = root.size(); 
     457 * <pre>var amount = root.size(); 
    458458 * for (var i=0; i &lt; amount; i++){ 
    459459 * var myObject = root.get(i); 
     
    479479 * <br /><br /> 
    480480 * Example: 
    481  * <pre> var hobj = new HopObject(); 
     481 * <pre>var hobj = new HopObject(); 
    482482 * hobj.foo = new HopObject(); 
    483483 * res.debug(hobj.persist()); 
     
    507507 * <br /><br /> 
    508508 * Example: 
    509  * <pre> res.writeln(root.length); 
     509 * <pre>res.writeln(root.length); 
    510510 * 53874 
    511511 * root.prefetchChildren(0, 3); 
     
    534534 * <br /><br /> 
    535535 * Example: 
    536  * <pre> res.write(parent.size()); 
     536 * <pre>res.write(parent.size()); 
    537537 * 24 
    538538 * var child = parent.get(5); 
     
    558558 * <br /><br /> 
    559559 * Example: 
    560  * <pre> res.write(parent.size()); 
     560 * <pre>res.write(parent.size()); 
    561561 * <i>24</i> 
    562562 * var child = parent.get(5); 
     
    594594 * <br /><br /> 
    595595 * Example: 
    596  * <pre> Contents of the file root/example.skin: 
     596 * <pre>Contents of the file root/example.skin: 
    597597 * &lt;html&gt; 
    598598 * &lthead&gt; 
     
    604604 * &lt;/html&gt;</pre> 
    605605 * <b>Rendering the skin:</b> 
    606  * <pre> var param = new Object(); 
     606 * <pre>var param = new Object(); 
    607607 * param.bgcolor = "#ffcc00"; 
    608608 * param.title = "World"; 
     
    632632 * <br /><br /> 
    633633 * Example: 
    634  * <pre> var str = root.renderSkinAsString("example", param); 
     634 * <pre>var str = root.renderSkinAsString("example", param); 
    635635 * res.write(str); 
    636636 * &nbsp; 
     
    651651 * <br /><br /> 
    652652 * Example: 
    653  * <pre> res.write(root.size()); 
     653 * <pre>res.write(root.size()); 
    654654 * <i>5</i></pre> 
    655655 *  
     
    759759 * <br /><br /> 
    760760 * Example: 
    761  * <pre> function getChildElement(name) { 
     761 * <pre>function getChildElement(name) { 
    762762 * &nbsp;&nbsp;if (name == 'transient') { 
    763763 * &nbsp;&nbsp;&nbsp;&nbsp;return new HopObject(); 
  • apps/reference/trunk/coreEnvironment/Skin.js

    r8655 r8694  
    4343 * <br /><br /> 
    4444 * Example: 
    45  * <pre> // Two macro functions defined in a JavaScript file: 
     45 * <pre>// Two macro functions defined in a JavaScript file: 
    4646 * &nbsp; 
    4747 * function isAllowed_macro() { 
     
    7979 * <br /><br /> 
    8080 * Example: 
    81  * <pre> var skin1 = createSkin("myMacro"); 
     81 * <pre>var skin1 = createSkin("myMacro"); 
    8282 * var skin2 = createSkin("<% myMacro %>"); 
    8383 * var skin3 = createSkin("<% this.myMacro %>"); 
  • apps/reference/trunk/coreEnvironment/app.js

    r8693 r8694  
    6666 * <br /><br /> 
    6767 * Example: 
    68  * <pre> app.data.runlevel = 4; 
     68 * <pre>app.data.runlevel = 4; 
    6969 * app.data.language = "en"; 
    7070 * &nbsp; 
     
    145145 * <br /><br /> 
    146146 * Example: 
    147  * <pre> # File app.properties: 
     147 * <pre># File app.properties: 
    148148 * debug = true 
    149149 * color = #ffcc00 
     
    273273 * <br /><br /> 
    274274 * Example: 
    275  * <pre> # File helma/apps/test/app.properties: 
     275 * <pre># File helma/apps/test/app.properties: 
    276276 * debug = true 
    277277 * &nbsp; 
     
    686686 * <br /><br /> 
    687687 * Example: 
    688  * <pre> app.debug("This message is written to the test application's event log."); 
     688 * <pre>app.debug("This message is written to the test application's event log."); 
    689689 * app.debug("custom", "This message is written to the custom.log file."); 
    690690 * &nbsp; 
  • apps/reference/trunk/coreEnvironment/global.js

    r8691 r8694  
    122122 * "story", it will be accessible as path["story"] or path.story. 
    123123 * <br /><br /> 
    124  * <pre> for (var i=0; i &lt; path.length; i++) 
     124 * <pre>for (var i=0; i &lt; path.length; i++) 
    125125 * &nbsp;&nbsp;res.writeln(path[i]); 
    126126 * &nbsp; 
     
    269269 * <br /><br /> 
    270270 * Example: 
    271  * <pre> var fileOrDir = new File('static/test.txt');</pre> 
     271 * <pre>var fileOrDir = new File('static/test.txt');</pre> 
    272272 *  
    273273 * @param {String} filepath as String 
     
    287287 * <br /><br /> 
    288288 * Example: 
    289  * <pre> var ftp = new FtpClient("ftp.mydomain.com");</pre> 
     289 * <pre>var ftp = new FtpClient("ftp.mydomain.com");</pre> 
    290290 *  
    291291 * @param {String} server as String, the address of the FTP Server to connect to 
     
    305305 * <br /><br /> 
    306306 * Example: 
    307  * <pre> var img = new Image("http://helma.org/image.gif");</pre> 
     307 * <pre>var img = new Image("http://helma.org/image.gif");</pre> 
    308308 *  
    309309 * @param {String} url as String 
     
    358358 * <br /><br /> 
    359359 * Example: 
    360  * <pre> var xr = new Remote("http://helma.domain.tld:5056/"); 
     360 * <pre>var xr = new Remote("http://helma.domain.tld:5056/"); 
    361361 * var msg1 = xr.helmaorg.getXmlRpcMessage(); 
    362362 * if (msg1.error) 
     
    429429 * <br /><br /> 
    430430 * Example: 
    431  * <pre> var login = authenticate("user", "pass"); 
     431 * <pre>var login = authenticate("user", "pass"); 
    432432 * if (login) 
    433433 * &nbsp;&nbsp;&nbsp;res.write("Welcome back!"); 
     
    458458 * <br /><br /> 
    459459 * Example: 
    460  * <pre> var str = "Hello, &lt;% response.body %&gt;!"; 
     460 * <pre>var str = "Hello, &lt;% response.body %&gt;!"; 
    461461 * var skin = createSkin(str); 
    462462 * res.data.body = "World"; 
     
    507507 * <br /><br /> 
    508508 * Example: 
    509  * <pre> var str = encode("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;b&gt;"); 
     509 * <pre>var str = encode("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;b&gt;"); 
    510510 * res.write(str); 
    511511 * &nbsp; 
     
    538538 * <br /><br /> 
    539539 * Example: 
    540  * <pre> var str = encodeForm("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
     540 * <pre>var str = encodeForm("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
    541541 * res.write(str); 
    542542 * &nbsp; 
     
    568568 * <br /><br /> 
    569569 * Example: 
    570  * <pre> var str = encodeXml("&lt;title&gt;Sm&oslash;rebr&oslash;d&lt;/title&gt;"); 
     570 * <pre>var str = encodeXml("&lt;title&gt;Sm&oslash;rebr&oslash;d&lt;/title&gt;"); 
    571571 * res.write(str); 
    572572 * &nbsp; 
     
    597597 * <br /><br /> 
    598598 * Example: 
    599  * <pre> var str = format("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
     599 * <pre>var str = format("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
    600600 * res.write(str); 
    601601 * &nbsp; 
     
    629629 * <br /><br /> 
    630630 * Example: 
    631  * <pre> var str = format("Sm&oslash;rebr&oslash;d:\n\n&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
     631 * <pre>var str = format("Sm&oslash;rebr&oslash;d:\n\n&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
    632632 * res.write(str); 
    633633 * &nbsp; 
     
    663663 * <br /><br /> 
    664664 * Example: 
    665  * <pre> var dbConnection = getDBConnection("db_source_name"); 
     665 * <pre>var dbConnection = getDBConnection("db_source_name"); 
    666666 * &nbsp; 
    667667 * var dbRowset = dbConnection.executeRetrieval("select title from dummy"); 
  • apps/reference/trunk/coreEnvironment/req.js

    r8692 r8694  
    4444 * <br /><br /> 
    4545 * Example: 
    46  * <pre> res.write(req.action); 
     46 * <pre>res.write(req.action); 
    4747 * <i>edit</i></pre> 
    4848 *  
  • apps/reference/trunk/coreEnvironment/res.js

    r8693 r8694  
    5151 * <br /><br /> 
    5252 * Example: 
    53  * <pre> res.cache = true</pre> 
     53 * <pre>res.cache = true</pre> 
    5454 *  
    5555 * @type Boolean 
     
    8080 * <br /><br /> 
    8181 * Example: 
    82  * <pre> res.charset = "UTF8"; 
     82 * <pre>res.charset = "UTF8"; 
    8383 * res.write("&Auml; &Ouml; &Uuml; &auml; &ouml; &uuml; &szlig;"); 
    8484 * // this is displayed if the brower's encoding is set to "Western" 
     
    9696 * <br /><br /> 
    9797 * Example: 
    98  * <pre> res.contentType='text/plain'; 
     98 * <pre>res.contentType='text/plain'; 
    9999 * res.contentType='application/xhtml+xml';</pre> 
    100100 *  
     
    111111 * <br /><br /> 
    112112 * Example: 
    113  * <pre> File root/main.skin: 
     113 * <pre>File root/main.skin: 
    114114 * &lt;html&gt; 
    115115 * &lt;head&gt; 
     
    149149 * <br /><br /> 
    150150 * Example: 
    151  * <pre> res.write(res.error); 
     151 * <pre>res.write(res.error); 
    152152 * <i>Runtime error Syntax error detected near line 1, column 24, after in string starting  
    153153 * with: 'function main_action (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10) {'...</i></pre> 
     
    191191 * <br /><br /> 
    192192 * Example: 
    193  * <pre> //in this example this.modificationDate is a property storing 
     193 * <pre>//in this example this.modificationDate is a property storing 
    194194 * //the time of the last changes to the current object 
    195195 * res.lastModified = this.modificationDate;</pre> 
     
    216216 * <br /><br /> 
    217217 * Example: 
    218  * <pre> File main.skin: 
     218 * <pre>File main.skin: 
    219219 * &lt;% response.message %> 
    220220 * &nbsp; 
     
    238238 * <br /><br /> 
    239239 * Example: 
    240  * <pre> Inside an onRequest handler function: 
     240 * <pre>Inside an onRequest handler function: 
    241241 * &nbsp;&nbsp;res.meta.permissions = this.doSomething(); 
    242242 * &nbsp; 
     
    260260 * <br /><br /> 
    261261 * Example: 
    262  * <pre> res.status = 401; 
     262 * <pre>res.status = 401; 
    263263 * res.realm = "Helma protected area";</pre> 
    264264 *  
     
    273273 * <br /><br /> 
    274274 * Example: 
    275  * <pre> res.servletResponse.setHeader( "Content-Disposition",  
     275 * <pre>res.servletResponse.setHeader( "Content-Disposition",  
    276276 * &nbsp;&nbsp;( this.mimetype.startsWith( "image/" )? "" : "attachment;" ) +   
    277277 * &nbsp;&nbsp;"filename=\"" + this.name + "\"" );</pre> 
     
    316316 * <br /><br /> 
    317317 * Example: 
    318  * <pre> res.status = 401; 
     318 * <pre>res.status = 401; 
    319319 * //make sure to set res.realm as well when asking for http authentication 
    320320 * res.realm = "Helma protected area";</pre> 
     
    370370 * <br /><br /> 
    371371 * Example: 
    372  * <pre> for (var i in collection1) 
     372 * <pre>for (var i in collection1) 
    373373 * &nbsp;&nbsp;collection1.get(i).counter += 1; 
    374374 * // commit changes to elements of collection1 to db 
     
    397397 * <br /><br /> 
    398398 * Example: 
    399  * <pre> var now = new Date(); 
     399 * <pre>var now = new Date(); 
    400400 * res.debug("current time: " + now); 
    401401 * &nbsp; 
     
    433433 * <br /><br /> 
    434434 * Example: 
    435  * <pre> res.encode("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
     435 * <pre>res.encode("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
    436436 * <i>&amp;lt;b&amp;gt;Bananer v&amp;auml;xer 
    437437 * &amp;lt;br /&amp;gt; &amp;lt;br&amp;gt; minsann inte p&amp;aring; tr&amp;auml;d.&amp;lt;/b&amp;gt;</i></pre> 
     
    458458 * <br /><br /> 
    459459 * Example: 
    460  * <pre> var str = res.encodeForm("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
     460 * <pre>var str = res.encodeForm("&lt;b&gt;Bananer v&auml;xer\n minsann inte p&aring; tr&auml;d.&lt;/b&gt;"); 
    461461 * &nbsp; 
    462462 * <i>&amp;lt;b&amp;gt;Bananer v&amp;auml;xer 
     
    481481 * <br /><br /> 
    482482 * Example: 
    483  * <pre> res.encodeXml("&lt;title&gt;Sm&oslash;rebr&amp;oslash;d&lt;/title&gt;"); 
     483 * <pre>res.encodeXml("&lt;title&gt;Sm&oslash;rebr&amp;oslash;d&lt;/title&gt;"); 
    484484 * <i>&amp;lt;title&amp;gt;Sm&oslash;rebr&amp;amp;oslash;d&amp;lt;/title&amp;gt;</i></pre> 
    485485 *  
     
    499499 * <br /><br /> 
    500500 * Example: 
    501  * <pre> res.format("&lt;table&gt;\n&lt;tr&gt;&lt;td&gt;Bananer v&auml;xer\n minsann  
     501 * <pre>res.format("&lt;table&gt;\n&lt;tr&gt;&lt;td&gt;Bananer v&auml;xer\n minsann  
    502502 * inte p&aring; tr&auml;d.&lt;/td&gt;&lt;/tr&gt;\n&lt;/table&gt;"); 
    503503 * <i>&lt;table&gt; 
     
    553553 * <br /><br /> 
    554554 * Example: 
    555  * <pre> res.push(); 
     555 * <pre>res.push(); 
    556556 * res.write("foo"); 
    557557 * res.encode('.'); 
     
    595595 * <br /><br /> 
    596596 * Example: 
    597  * <pre> res.push(); 
     597 * <pre>res.push(); 
    598598 * res.write("foo"); 
    599599 * res.encode('.'); 
     
    630630 * <br /><br /> 
    631631 * Example: 
    632  * <pre> res.redirect(this.href());</pre> 
     632 * <pre>res.redirect(this.href());</pre> 
    633633 */ 
    634634res.redirect = function() {}; 
     
    639639 * <br /><br /> 
    640640 * Example: 
    641  * <pre> res.write("Test"); 
     641 * <pre>res.write("Test"); 
    642642 * // changing my mind (e.g. an error occured) 
    643643 * res.reset(); 
     
    675675 * <br /><br /> 
    676676 * Example: 
    677  * <pre> res.setCookie("username", "michi"); 
     677 * <pre>res.setCookie("username", "michi"); 
    678678 * res.setCookie("password", "strenggeheim", 10, "/mypath", ".mydomain.org");</pre> 
    679679 *  
     
    721721 * <br /><br /> 
    722722 * Example: 
    723  * <pre> function onRequest() { 
     723 * <pre>function onRequest() { 
    724724 * &nbsp;&nbsp;if (fooIsCached()) { 
    725725 * &nbsp;&nbsp;&nbsp;&nbsp;res.write(fooFromCache()); 
     
    742742 * <br /><br /> 
    743743 * Example: 
    744  * <pre> var now = new Date(); 
     744 * <pre>var now = new Date(); 
    745745 * res.write("current time: " + now); 
    746746 * &nbsp; 
     
    760760 * <br /><br /> 
    761761 * Example: 
    762  * <pre> var upload = req.data.fileUpload; 
     762 * <pre>var upload = req.data.fileUpload; 
    763763 * res.writeBinary(upload.getContent());</pre> 
    764764 *  
     
    778778 * <br /><br /> 
    779779 * Example: 
    780  * <pre> var now = new Date(); 
     780 * <pre>var now = new Date(); 
    781781 * res.writeln("current time:"); 
    782782 * res.writeln(now); 
  • apps/reference/trunk/coreEnvironment/session.js

    r8655 r8694  
    6565 * <br /><br /> 
    6666 * Example: 
    67  * <pre> res.writeln(session._id); 
     67 * <pre>res.writeln(session._id); 
    6868 * <i>1fcca129764400&#64;eefa22dfab</i></pre> 
    6969 *  
     
    8383 * <br /><br /> 
    8484 * Example: 
    85  * <pre> res.writeln(session.cookie); 
     85 * <pre>res.writeln(session.cookie); 
    8686 * <i>1fcca129764400&#64;eefa22dfab</i></pre> 
    8787 *  
     
    102102 * <br /><br /> 
    103103 * Example: 
    104  * <pre> session.data.lastclick = new Date(); 
     104 * <pre>session.data.lastclick = new Date(); 
    105105 * session.data.language = "en"; 
    106106 * &nbsp; 
     
    140140 * <br /><br /> 
    141141 * Example: 
    142  * <pre> if (session.lastModified < this.modifytime) 
     142 * <pre>if (session.lastModified < this.modifytime) 
    143143 * &nbsp;&nbsp;renderSkin("main"); 
    144144 * else 
     
    170170 * <br /><br /> 
    171171 * Example: 
    172  * <pre> session.login("tobi", "mumbl3"); 
     172 * <pre>session.login("tobi", "mumbl3"); 
    173173 * res.write(session.user); 
    174174 * <i>HopObject tobi</i> 
     
    201201 * <br /><br /> 
    202202 * Example: 
    203  * <pre> res.write(session.lastActive()) 
     203 * <pre>res.write(session.lastActive()) 
    204204 * <i>Thu Nov 02 16:12:13 GMT+01:00 2000</i></pre> 
    205205 *  
     
    228228 * <br /><br /> 
    229229 * Example: 
    230  * <pre> var login = session.login("tobi", "mumbl3"); 
     230 * <pre>var login = session.login("tobi", "mumbl3"); 
    231231 * if (login) 
    232232 * &nbsp;&nbsp;res.write("Welcome back, " + session.user.name + "!"); 
     
    252252 * <br /><br /> 
    253253 * Example: 
    254  * <pre> res.write(session); 
     254 * <pre>res.write(session); 
    255255 * <i>[Session for user tobi]</i> 
    256256 * &nbsp; 
     
    268268 * <br /><br /> 
    269269 * Example: 
    270  * <pre> res.write(session.onSince()); 
     270 * <pre>res.write(session.onSince()); 
    271271 * <i>Fri Aug 10 16:36:36 GMT+02:00 2001</i></pre> 
    272272 *  
     
    288288 * <br /><br /> 
    289289 * Example: 
    290  * <pre> res.writeln(session.lastActive); 
     290 * <pre>res.writeln(session.lastActive); 
    291291 * <i>Fri Jul 12 14:40:20 CEST 2002</i> 
    292292 * &nbsp; 
  • apps/reference/trunk/coreExtensions/File.js

    r8689 r8694  
    2525 * <br /><br /> 
    2626 * Example: 
    27  * <pre> var fileOrDir = new File('static/test.txt');</pre> 
     27 * <pre>var fileOrDir = new File('static/test.txt');</pre> 
    2828 *  
    2929 * @param {String} filepath as String 
     
    9595 * <br /><br /> 
    9696 * Example: 
    97  * <pre> var xmlFiles = dir.list(/.*\.xml/);</pre> 
     97 * <pre>var xmlFiles = dir.list(/.*\.xml/);</pre> 
    9898 *  
    9999 * @param {RegExp} pattern as RegExp, optional pattern to test each file name against 
  • apps/reference/trunk/coreExtensions/FtpClient.js

    r8689 r8694  
    2828 * <br /><br /> 
    2929 * Example: 
    30  * <pre> var ftp = new FtpClient("ftp.mydomain.com");</pre> 
     30 * <pre>var ftp = new FtpClient("ftp.mydomain.com");</pre> 
    3131 *  
    3232 * @param {String} server as String, the address of the FTP Server to connect to 
     
    4141 * <br /><br /> 
    4242 * Example: 
    43  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     43 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    4444 * ftp.login("user", "pass"); 
    4545 * ftp.ascii();</pre> 
     
    5252 * <br /><br /> 
    5353 * Example: 
    54  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     54 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    5555 * ftp.login("user", "pass"); 
    5656 * ftp.binary();</pre> 
     
    6363 * <br /><br /> 
    6464 * Example: 
    65  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     65 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    6666 * ftp.login("user", "pass"); 
    6767 * &nbsp; 
     
    8484 * <br /><br /> 
    8585 * Example: 
    86  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     86 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    8787 * ftp.login("user", "pass"); 
    8888 * ftp.getFile(".htaccess", "htaccess.txt");</pre> 
     
    100100 * <br /><br /> 
    101101 * Example: 
    102  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     102 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    103103 * ftp.login("user", "pass"); 
    104104 * var str = ftp.getString("messages.txt");</pre> 
     
    116116 * <br /><br /> 
    117117 * Example: 
    118  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     118 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    119119 * ftp.login("user", "pass"); 
    120120 * &nbsp; 
     
    139139 * <br /><br /> 
    140140 * Example: 
    141  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     141 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    142142 * if (ftp.login("user", "pass")) 
    143143 * &nbsp;&nbsp;res.write("User logged in."); 
     
    159159 * <br /><br /> 
    160160 * Example: 
    161  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     161 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    162162 * ftp.login("user", "pass"); 
    163163 * ftp.putFile("htaccess.txt", ".htaccess"); 
     
    176176 * <br /><br /> 
    177177 * Example: 
    178  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     178 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    179179 * ftp.login("user", "pass"); 
    180180 * if (ftp.mkdir("testdir")) 
     
    196196 * <br /><br /> 
    197197 * Example: 
    198  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     198 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    199199 * ftp.login("user", "pass"); 
    200200 * if (ftp.putFile("testfile")) 
     
    216216 * <br /><br /> 
    217217 * Example: 
    218  * <pre> var ftp = new FtpClient("ftp.host.dom"); 
     218 * <pre>var ftp = new FtpClient("ftp.host.dom"); 
    219219 * ftp.login("user", "pass"); 
    220220 * ftp.putString("Hello, World!", "message.txt");</pre> 
  • apps/reference/trunk/coreExtensions/Image.js

    r8693 r8694  
    2727 * <br /><br /> 
    2828 * Example: 
    29  * <pre> var img = new Image("http://helma.org/image.gif");</pre> 
     29 * <pre>var img = new Image("http://helma.org/image.gif");</pre> 
    3030 *  
    3131 * @param {String} img as String of a URL, or a java.io.InputStream object 
     
    4545 * <br /><br /> 
    4646 * Example: 
    47  * <pre> var img = new Image("http://helma.org/images/original.gif"); 
     47 * <pre>var img = new Image("http://helma.org/images/original.gif"); 
    4848 * res.write('&lt:img src="/images/original.gif" /&gt;'); 
    4949 * &nbsp; 
     
    7272 * <br /><br /> 
    7373 * Example: 
    74  * <pre> var img = new Image("http://helma.org/images/original.jpg"); 
     74 * <pre>var img = new Image("http://helma.org/images/original.jpg"); 
    7575 * // do something useful or funny with the image 
    7676 * img.dispose();</pre> 
     
    8888 * <br /><br /> 
    8989 * Example: 
    90  * <pre> var img = new Image("http://helma.org/images/original.gif"); 
     90 * <pre>var img = new Image("http://helma.org/images/original.gif"); 
    9191 * res.write('&lt;img src="/images/original.gif" /&gt;'); 
    9292 * &nbsp; 
     
    118118 * <br /><br /> 
    119119 * Example: 
    120  * <pre> var img = new Image("http://helma.org/images/originalgif"); 
     120 * <pre>var img = new Image("http://helma.org/images/originalgif"); 
    121121 * res.write('&lt;img src="/images/original.gif" /&gt;'); 
    122122 * &nbsp; 
     
    145145 * <br /><br /> 
    146146 * Example: 
    147  * <pre> var img = new Image("http://helma.org/images/original.gif"); 
     147 * <pre>var img = new Image("http://helma.org/images/original.gif"); 
    148148 * res.write('&lt;img src="/images/original.gif" /&gt;'); 
    149149 * &nbsp; 
     
    174174 * <br /><br /> 
    175175 * Example: 
    176  * <pre> var img = new Image("http://helma.org/images/original.gif"); 
     176 * <pre>var img = new Image("http://helma.org/images/original.gif"); 
    177177 * res.write('&lt;img src="/images/original.gif" /&gt;'); 
    178178 * &nbsp; 
     
    198198 * <br /><br /> 
    199199 * Example: 
    200  * <pre> var img = new Image("http://helma.org/images/hop.gif"); 
     200 * <pre>var img = new Image("http://helma.org/images/hop.gif"); 
    201201 * res.write('&lt;img src="/images/hop.gif" /&gt;'); 
    202202 * &nbsp; 
     
    222222 * Example: 
    223223 * &nbsp; 
    224  * <pre> var info = Image.getInfo("http://helma.org/images/hop.gif"); 
     224 * <pre>var info = Image.getInfo("http://helma.org/images/hop.gif"); 
    225225 * if (info) { 
    226226 * &nbsp;&nbsp;res.writeln('width: ' + info.width); 
     
    260260 * <br /><br /> 
    261261 * <b>The following filter functions have been successfully applied the way as described in the examples below:</b> 
    262  * <pre> &nbsp;&nbsp;* Rotate(degreeNumber) 
     262 * <pre>&nbsp;&nbsp;* Rotate(degreeNumber) 
    263263 * &nbsp;&nbsp;* Gray() 
    264264 * &nbsp;&nbsp;* Flip(typeNumber) 
     
    275275 * <br /><br /> 
    276276 * Example: 
    277  * <pre> var img = new Image("http://helma.org/static/original.jpg"); 
     277 * <pre>var img = new Image("http://helma.org/static/original.jpg"); 
    278278 * var filters = Packages.com.sun.jimi.core.filters; 
    279279 * var rotator = new filters.Rotate(45); 
     
    302302 * <br /><br /> 
    303303 * Example: 
    304  * <pre> var img = new Image("http://helma.org/images/hop.gif"); 
     304 * <pre>var img = new Image("http://helma.org/images/hop.gif"); 
    305305 * res.write('&lt;img src="/images/hop.gif" /&gt;'); 
    306306 * &nbsp; 
     
    323323 * <br /><br /> 
    324324 * Example: 
    325  * <pre> var img = new Image("http://helma.org/images/original.jpg"); 
     325 * <pre>var img = new Image("http://helma.org/images/original.jpg"); 
    326326 * res.write('&lt;img src="/images/original.jpg" /&gt;'); 
    327327 * &nbsp; 
     
    348348 * <br /><br /> 
    349349 * Example: 
    350  * <pre> var img = new Image("http://helma.org/images/original.jpg"); 
     350 * <pre>var img = new Image("http://helma.org/images/original.jpg"); 
    351351 * res.write('&ltimg src="/images/original.jpg" /&gt;'); 
    352352 * &nbsp; 
     
    376376 * <br /><br /> 
    377377 * Example: 
    378  * <pre> var img = new Image("http://helma.org/images/original.jpg"); 
     378 * <pre>var img = new Image("http://helma.org/images/original.jpg"); 
    379379 * res.write('&lt;img src="/images/original.jpg" /&gt;'); 
    380380 * &nbsp; 
     
    412412 * <br /><br /> 
    413413 * Example: 
    414  * <pre> var img = new Image("http://helma.org/images/original.jpg"); 
     414 * <pre>var img = new Image("http://helma.org/images/original.jpg"); 
    415415 * res.write('&lt;img src="/images/original.jpg" /&gt;'); 
    416416 * &nbsp; 
  • apps/reference/trunk/coreExtensions/Mail.js

    r8693 r8694  
    5151 * <br /><br /> 
    5252 * Example: 
    53  * <pre> var mail = new Mail(); 
     53 * <pre>var mail = new Mail(); 
    5454 * mail.addBCC("hop&#64;helma.at"); 
    5555 * mail.addBCC("tobi&#64;helma.at", "Tobi Schaefer");</pre> 
     
    6868 * <br /><br /> 
    6969 * Example: 
    70  * <pre> var mail = new Mail(); 
     70 * <pre>var mail = new Mail(); 
    7171 * mail.addCC("hop&#64;helma.at"); 
    7272 * mail.addCC("tobi&#64;helma.at", "Tobi Schaefer");</pre> 
     
    8787 * <br /><br /> 
    8888 * Example: 
    89  * <pre> var file1 = getURL("http://localhost:8080/static/image.gif"); 
     89 * <pre>var file1 = getURL("http://localhost:8080/static/image.gif"); 
    9090 * var file2 = getURL("file:////home/snoopy/woodstock.jpg"); 
    9191 * var file3 = new java.io.File("/home/snoopy/woodstock.jpg"); 
     
    114114 * <br /><br /> 
    115115 * Example: 
    116  * <pre> var mail = new Mail(); 
     116 * <pre>var mail = new Mail(); 
    117117 * mail.addText("Hello, World!");</pre> 
    118118 *  
     
    129129 * <br /><br /> 
    130130 * Example: 
    131  * <pre> var mail = new Mail(); 
     131 * <pre>var mail = new Mail(); 
    132132 * mail.setTo("hop&#64;helma.at"); 
    133133 * mail.addTo("hopdoc&#64;helma.at"); 
     
    149149 * <br /><br /> 
    150150 * Example: 
    151  * <pre> var mail = new Mail(); 
     151 * <pre>var mail = new Mail(); 
    152152 * mail.setTo("watching&#64;michi.tv", "michi"); 
    153153 * mail.addCC("franzi&#64;home.at", "franzi"); 
     
    169169 * <br /><br /> 
    170170 * Example: 
    171  * <pre> var mail = new Mail(); 
     171 * <pre>var mail = new Mail(); 
    172172 * mail.setFrom("tobi&#64;helma.at", "Tobi Schaefer");</pre> 
    173173 *  
     
    182182 * <br /><br /> 
    183183 * Example: 
    184  * <pre> var mail = new Mail(); 
     184 * <pre>var mail = new Mail(); 
    185185 * mail.setSubject("Hello, World!");</pre> 
    186186 *  
     
    198198 * <br /><br /> 
    199199 * Example: 
    200  * <pre> var mail = new Mail(); 
     200 * <pre>var mail = new Mail(); 
    201201 * mail.setTo("hop&#64;helma.at");</pre> 
    202202 *  
  • apps/reference/trunk/coreExtensions/Xml.js

    r8604 r8694  
    3333 * <br /><br /> 
    3434 * Syntax: 
    35  * <pre> Xml.get(urlString) 
     35 * <pre>Xml.get(urlString) 
    3636 * Xml.get(urlString, filenameString)</pre> 
    3737 * <br /><br /> 
     
    4141 * <br /><br /> 
    4242 * Example: 
    43  * <pre> var obj = Xml.get("http://localhost:8080/antville/rss10"); 
     43 * <pre>var obj = Xml.get("http://localhost:8080/antville/rss10"); 
    4444 * for (var i in obj) 
    4545 * &nbsp;&nbsp;res.writeln(i + ": " + obj[i]); 
     
    6363 * <br /><br /> 
    6464 * Syntax: 
    65  * <pre> Xml.getFromString(xmlString) 
     65 * <pre>Xml.getFromString(xmlString) 
    6666 * Xml.getFromString(xmlString, filenameString)</pre> 
    6767 * <br /><br /> 
     
    7171 * <br /><br /> 
    7272 * Example: 
    73  * <pre> var obj = Xml.getFromString("&lt;a&gt;hello &lt;b&gt;world&lt;/b&gt;&lt;/a&gt;"); 
     73 * <pre>var obj = Xml.getFromString("&lt;a&gt;hello &lt;b&gt;world&lt;/b&gt;&lt;/a&gt;"); 
    7474 * for (var i in obj) 
    7575 * &nbsp;&nbsp;res.writeln(i + ": " + obj[i]); 
     
    8989 * <br /><br /> 
    9090 * Syntax: 
    91  * <pre> Xml.read(filenameString) 
     91 * <pre>Xml.read(filenameString) 
    9292 * Xml.read(filenameString, HopObject)</pre> 
    9393 * <br /><br /> 
     
    9696 * <br /><br /> 
    9797 * Example: 
    98  * <pre> var obj = Xml.read("/tmp/dump.xml"); 
     98 * <pre>var obj = Xml.read("/tmp/dump.xml"); 
    9999 * res.write(obj); 
    100100 * <i>HopObject message</i></pre> 
     
    111111 * <br /><br /> 
    112112 * Syntax: 
    113  * <pre> Xml.readFromString(String) 
     113 * <pre>Xml.readFromString(String) 
    114114 * Xml.readFromString(String, HopObject)</pre> 
    115115 * <br /><br /> 
     
    118118 * <br /><br /> 
    119119 * Example: 
    120  * <pre> var f = new File("/tmp/dump.xml"); 
     120 * <pre>var f = new File("/tmp/dump.xml"); 
    121121 * var obj = Xml.readFromString(f.readAll()); 
    122122 * res.write(obj); 
     
    134134 * <br /><br /> 
    135135 * Syntax: 
    136  * <pre> Xml.write(HopObject, filenameString)</pre> 
     136 * <pre>Xml.write(HopObject, filenameString)</pre> 
    137137 * <br /><br /> 
    138138 * Example: 
    139  * <pre> var obj = new message(); 
     139 * <pre>var obj = new message(); 
    140140 * obj.title = "The Message"; 
    141141 * obj.text = "Don't push me 'cause I'm close to the edge."; 
     
    168168 * <br /><br /> 
    169169 * Syntax: 
    170  * <pre> Xml.writeToString(HopObject)</pre> 
     170 * <pre>Xml.writeToString(HopObject)</pre> 
    171171 * <br /><br /> 
    172172 * Example: 
    173  * <pre> var str = Xml.writeToString(this.get(0)); 
     173 * <pre>var str = Xml.writeToString(this.get(0)); 
    174174 * res.write(str); 
    175175 * &nbsp;