[89] | 1 | |
---|
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 3 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 4 | |
---|
| 5 | <!-- Template needs structure with the following fields: |
---|
| 6 | version : IDLdoc version |
---|
| 7 | date : string containing date of file creation |
---|
| 8 | embed : 0 for link to CSS, 1 for embed CSS |
---|
| 9 | css_location : if embed then string filename of CSS file location, o/w href to CSS file |
---|
| 10 | navbar_filename : filename of navbar template |
---|
| 11 | footer : filename of footer file to include |
---|
| 12 | tagline_filename : filename of tagline template |
---|
| 13 | Plus fields needed by the templates: navbar, tagline |
---|
| 14 | --> |
---|
| 15 | |
---|
| 16 | <!-- Generated by IDLdoc 2.0 --> |
---|
| 17 | |
---|
| 18 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 19 | <head> |
---|
[104] | 20 | <title>IDLdoc Help (SAXO Documentation)</title> |
---|
[89] | 21 | |
---|
| 22 | |
---|
| 23 | <link rel="stylesheet" type="text/css" href=".//main_files.css" media="all"/> |
---|
| 24 | <link rel="stylesheet" type="text/css" href=".//main_files_print.css" media="print"/> |
---|
| 25 | |
---|
| 26 | |
---|
| 27 | <script type="text/javascript"> |
---|
| 28 | function setTitle() { |
---|
[104] | 29 | parent.document.title="Help (SAXO Documentation)"; |
---|
[89] | 30 | } |
---|
| 31 | </script> |
---|
| 32 | </head> |
---|
| 33 | |
---|
| 34 | <body onload="setTitle();"> |
---|
| 35 | |
---|
| 36 | <div id="navbar_title"> |
---|
[104] | 37 | <h1>SAXO Documentation</h1> |
---|
[89] | 38 | </div> |
---|
| 39 | |
---|
| 40 | |
---|
| 41 | <div id="main_navbar"> |
---|
| 42 | |
---|
| 43 | <table cellspacing="0"> |
---|
| 44 | <tr> |
---|
| 45 | |
---|
| 46 | <td><a href="overview.html?format=raw" title="Overview of library">Overview</a></td> |
---|
| 47 | |
---|
| 48 | |
---|
| 49 | |
---|
| 50 | <td >Directory</td> |
---|
| 51 | |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | <td><a href="idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | <td><a href="idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
| 59 | |
---|
| 60 | |
---|
| 61 | |
---|
| 62 | <td><a href="search-page.html?format=raw" title="Search library">Search</a></td> |
---|
| 63 | |
---|
| 64 | |
---|
| 65 | <td >File</td> |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | <td >Source</td> |
---|
| 69 | |
---|
| 70 | |
---|
| 71 | |
---|
| 72 | <td id="selected">Help</td> |
---|
| 73 | |
---|
| 74 | |
---|
| 75 | <td >Etc</td> |
---|
| 76 | |
---|
| 77 | <td id="flexible">Developer documentation</td> |
---|
| 78 | </tr> |
---|
| 79 | </table> |
---|
| 80 | |
---|
| 81 | </div> |
---|
| 82 | |
---|
| 83 | <div id="secondary_navbar"> |
---|
| 84 | |
---|
[107] | 85 | << prev file | next file >> <a href="idldoc-help.html?format=raw" target="_TOP">view single page</a> | <a href="index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: routine |
---|
[89] | 86 | |
---|
| 87 | </div> |
---|
| 88 | |
---|
| 89 | |
---|
| 90 | <div id="container"> |
---|
| 91 | |
---|
| 92 | <div class="toc small"> |
---|
| 93 | <ol class="toc"> |
---|
| 94 | <li><a href="idldoc-help.html?format=raw">Help for users of an IDLdoc'ed library</a></li> |
---|
| 95 | <li><a href="idldoc-dev-help.html?format=raw">Basic markup of code</a></li> |
---|
| 96 | <li><a href="idldoc-dev-help2.html?format=raw">Modifying IDLdoc output</a></li> |
---|
| 97 | </ol> |
---|
| 98 | </div> |
---|
| 99 | |
---|
| 100 | <h1>Help on IDLdoc output</h1> |
---|
| 101 | |
---|
| 102 | <p>The following information is provides documentation in |
---|
| 103 | interpreting the results of the output of IDLdoc. For |
---|
| 104 | documentation on marking up IDL code to better use IDLdoc's |
---|
| 105 | capabilities, see the <a href="idldoc-dev-help.html?format=raw">developer's |
---|
| 106 | help</a> or the <a href="idldoc-dev-help2.html?format=raw">advanced developer's help</a>.</p> |
---|
| 107 | |
---|
| 108 | <h2>File summary</h2> |
---|
| 109 | |
---|
| 110 | <p>The file summary includes a the class hierarchy diagram for |
---|
| 111 | files with names ending in __define, a list of various |
---|
| 112 | attributes of the file, and a description.</p> |
---|
| 113 | |
---|
| 114 | <h2>Field summary</h2> |
---|
| 115 | |
---|
| 116 | <p>If the filename of PRO file ends in __define, then the fields |
---|
| 117 | defined in the routine of the same name are listed with their |
---|
| 118 | type and any comments provided by the developer. Following this |
---|
| 119 | listing are separate listings for each parent class of the |
---|
| 120 | class/structure with a list of their fields with types.</p> |
---|
| 121 | |
---|
| 122 | <h2>Routine summary</h2> |
---|
| 123 | |
---|
| 124 | <p>The routine summary simply provides the calling sequence for |
---|
| 125 | each routine in the file (in the same syntax is the online help |
---|
| 126 | for IDL) and the first sentence of the detailed description for |
---|
| 127 | each routine in the file.</p> |
---|
| 128 | |
---|
| 129 | <h2>Routine details</h2> |
---|
| 130 | |
---|
| 131 | <p>The routine details sections gives a possibly longer |
---|
| 132 | description of the routine as well as a tables of the parameters |
---|
| 133 | and keywords accepted by the routine. Also listed are various |
---|
| 134 | attributes of the routine.</p> |
---|
| 135 | |
---|
| 136 | <p>All the parameters and keywords of the routine will be in |
---|
| 137 | these tables regardless if they have been commented using IDLdoc |
---|
| 138 | (though the developer can hide parameters and keywords if they |
---|
| 139 | chose).</p> |
---|
| 140 | |
---|
| 141 | <h3>Routine attributes</h3> |
---|
| 142 | |
---|
| 143 | <p>A routine can be marked with various attributes described in |
---|
| 144 | the below table.</p> |
---|
| 145 | |
---|
| 146 | <table class="basic" cellspacing="0"> |
---|
| 147 | <tr> |
---|
| 148 | <th>Attribute</th> |
---|
| 149 | <th>Description</th> |
---|
| 150 | </tr> |
---|
| 151 | <tr> |
---|
| 152 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">abstract</span></h2></td> |
---|
| 153 | <td> |
---|
| 154 | The routine name will be italicized if the routine is |
---|
| 155 | marked "abstract" (meaning it is not implemented, it is |
---|
| 156 | provided for its interface only). This is generally used |
---|
| 157 | in only object-oriented programming. |
---|
| 158 | </td> |
---|
| 159 | </tr> |
---|
| 160 | <tr> |
---|
| 161 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">private</span></h2></td> |
---|
| 162 | <td> |
---|
| 163 | This routine is not intended to be called except by other |
---|
| 164 | routines in the same file. In other words it is a "helper |
---|
| 165 | routine". Private routines are only seen if the library is |
---|
| 166 | IDLdoc'ed in "developer" mode. |
---|
| 167 | </td> |
---|
| 168 | </tr> |
---|
| 169 | <tr> |
---|
| 170 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="warning">obsolete</span></h2></td> |
---|
| 171 | <td> |
---|
| 172 | This routine is no longer supported by the library |
---|
| 173 | maintainer. |
---|
| 174 | </td> |
---|
| 175 | </tr> |
---|
| 176 | <tr> |
---|
| 177 | <td><h2 style="padding-top: 0; margin-top: 0.1em;"><span class="categories">categories</span></h2></td> |
---|
| 178 | <td> |
---|
| 179 | The names of any categories for the routine are listed. |
---|
| 180 | </td> |
---|
| 181 | </tr> |
---|
| 182 | </table> |
---|
| 183 | |
---|
| 184 | <h3>Parameter and keyword attributes</h3> |
---|
| 185 | |
---|
| 186 | <p>A parameter or keyword can be marked with various attributes |
---|
| 187 | described in the below table.</p> |
---|
| 188 | |
---|
| 189 | <table class="basic" cellspacing="0"> |
---|
| 190 | <tr> |
---|
| 191 | <th>Attribute</th> |
---|
| 192 | <th>Description</th> |
---|
| 193 | </tr> |
---|
| 194 | <tr> |
---|
| 195 | <td><span class="attr">in</span></td> |
---|
| 196 | <td> |
---|
| 197 | Indicates that the argument is intended to be passed into |
---|
| 198 | the routine. |
---|
| 199 | </td> |
---|
| 200 | </tr> |
---|
| 201 | <tr> |
---|
| 202 | <td><span class="attr">out</span></td> |
---|
| 203 | <td> |
---|
| 204 | Indicates that the argument is intended to be used to pass |
---|
| 205 | a value out of the routine. A named variable must be |
---|
| 206 | passed to the routine to pass a value back to the calling |
---|
| 207 | level. |
---|
| 208 | </td> |
---|
| 209 | </tr> |
---|
| 210 | <tr> |
---|
| 211 | <td><span class="attr">optional</span></td> |
---|
| 212 | <td> |
---|
| 213 | This attribute indicates the argument is optional; |
---|
| 214 | optional parameters and keywords are also placed inside |
---|
| 215 | brackets ([]) in the routine summary. |
---|
| 216 | </td> |
---|
| 217 | </tr> |
---|
| 218 | <tr> |
---|
| 219 | <td><span class="attr">required</span></td> |
---|
| 220 | <td>Indicates the argument is required</td> |
---|
| 221 | </tr> |
---|
| 222 | <tr> |
---|
| 223 | <td><span class="attr">type</span></td> |
---|
| 224 | <td> |
---|
| 225 | Type indicates the IDL type of the variable. Can be used |
---|
| 226 | indicate a group of types, a specific type, an array of a |
---|
| 227 | certain type, etc. Boolean keywords are indicated by a |
---|
| 228 | /KEYWORD_NAME in the routine summary. |
---|
| 229 | </td> |
---|
| 230 | </tr> |
---|
| 231 | <tr> |
---|
| 232 | <td><span class="attr">default</span></td> |
---|
| 233 | <td> |
---|
| 234 | Default indicates the default value for an optional |
---|
| 235 | parameter or keyword. |
---|
| 236 | </td> |
---|
| 237 | </tr> |
---|
| 238 | <tr> |
---|
| 239 | <td><span class="attr">private</span></td> |
---|
| 240 | <td> |
---|
| 241 | This parameter is not intended to be used in calls except |
---|
| 242 | by other routines in the same file. Private parameters are |
---|
| 243 | only seen if the library is IDLdoc'ed in "developer" mode. |
---|
| 244 | </td> |
---|
| 245 | </tr> |
---|
| 246 | </table> |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 251 | |
---|
| 252 | </div> |
---|
| 253 | </body> |
---|
| 254 | </html> |
---|