Changes between Version 17 and Version 18 of NaturalDocs

Show
Ignore:
Timestamp:
07/09/07 13:39:28 (6 years ago)
Author:
tschaub
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • NaturalDocs

    v17 v18  
    1717{{{ 
    1818/** 
    19  * Start of comment block 
     19 * Paragraphs start here. 
    2020 * 
    21  * End of comment block 
     21 * Space between paragraphs.  Lines wrap at 80 characters.  Long paragraphs are 
     22 *     indented with four extra spaces.  Lorem ipsum dolor sit amet, 
     23 *     consectetuer adipiscing elit. Phasellus ornare.  Integer luctus lectus 
     24 *     sed est.  Suspendisse potenti.  Aliquam nec mi. Sed nec sapien. 
    2225 */ 
    23  
    2426}}} 
    2527 
    … …  
    3638     * Property: name 
    3739     * {type} Short Description. And the rest of the Full Description 
    38      *        is here for your reading convenience. 
     40     *     is here for your reading convenience. 
    3941     */ 
    4042    name: value 
    … …  
    5658     * Parameters: 
    5759     * param1 - {String} Describe param1 here so that everyone will know 
    58      *                   just exactly what to pass.  
     60     *     just exactly what to pass.  
    5961     * param2 - {<OpenLayers.Map>} Describe param2 here so that those same 
    60      *                             folks from above won't get confused. 
     62     *     folks from above won't get confused. 
    6163     */ 
    6264    functionName: function(param1, param2) { 
    … …  
    7476    /** 
    7577     * Function: functionName 
    76      * Describe the function here 
     78     * Describe the function here. 
    7779     * 
    7880     * Parameters: 
    … …  
    8284     * Return: 
    8385     * {Number} Describe the return here because how is anyone  
    84      *          supposed to know what a function does if it does not 
    85      *          have a clearly documented return function? 
     86     *     supposed to know what a function does if it does not 
     87     *     have a clearly documented return function? 
    8688     */ 
    8789    functionName: function(param1, param2) { 
    … …  
    137139     * name - {String} A name for the layer 
    138140     * url - {String} Base url for the WMS 
    139      *                (e.g. http://wms.jpl.nasa.gov/wms.cgi) 
     141     *     (e.g. http://wms.jpl.nasa.gov/wms.cgi) 
    140142     * params - {Object} An object with key/value pairs representing the 
    141      *                   GetMap query string parameters and parameter values. 
     143     *     GetMap query string parameters and parameter values. 
    142144     * options - {Ojbect} Hashtable of extra options to tag onto the layer 
    143145     */ 
    … …  
    163165     * Property: myPrivateProperty 
    164166     * {String} Short Description about a private property. And the  
    165      *          Full Description afterwards. Para variar. 
     167     *     Full Description afterwards. Para variar. 
    166168     */ 
    167169    myPrivateProperty: "some private value" 
    … …  
    176178     * APIProperty: myPublicProperty 
    177179     * {String} Short Description about a public property. And the  
    178      *          Full Description. Musico en vivo cada noche. 
     180     *     Full Description. Musico en vivo cada noche. 
    179181     */ 
    180182    myPublicProperty: "some public value"