[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 | idldoc_syntax_filename : file containing IDLdoc output for the idldoc routine |
---|
| 11 | navbar_filename : filename of navbar template |
---|
| 12 | footer : filename of footer file to include |
---|
| 13 | tagline_filename : filename of tagline template |
---|
| 14 | Plus stuff needed by the templates: navbar, tagline |
---|
| 15 | --> |
---|
| 16 | |
---|
| 17 | <!-- Generated by IDLdoc 2.0 --> |
---|
| 18 | |
---|
| 19 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 20 | <head> |
---|
[104] | 21 | <title>IDLdoc Developer's Help (SAXO Documentation)</title> |
---|
[89] | 22 | |
---|
| 23 | |
---|
[191] | 24 | <link rel="stylesheet" type="text/css" href=".//main_files.css" media="all"/> |
---|
| 25 | <link rel="stylesheet" type="text/css" href=".//main_files_print.css" media="print"/> |
---|
[89] | 26 | |
---|
| 27 | |
---|
| 28 | <script type="text/javascript"> |
---|
| 29 | function setTitle() { |
---|
[104] | 30 | parent.document.title="IDLdoc Developer's Help (SAXO Documentation)"; |
---|
[89] | 31 | } |
---|
| 32 | </script> |
---|
| 33 | </head> |
---|
| 34 | |
---|
| 35 | |
---|
| 36 | <body onload="setTitle();"> |
---|
| 37 | |
---|
| 38 | <div id="navbar_title"> |
---|
[104] | 39 | <h1>SAXO Documentation</h1> |
---|
[89] | 40 | </div> |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | <div id="main_navbar"> |
---|
| 44 | |
---|
| 45 | <table cellspacing="0"> |
---|
| 46 | <tr> |
---|
| 47 | |
---|
[189] | 48 | <td><a href="overview.html" title="Overview of library">Overview</a></td> |
---|
[89] | 49 | |
---|
| 50 | |
---|
| 51 | |
---|
| 52 | <td >Directory</td> |
---|
| 53 | |
---|
| 54 | |
---|
| 55 | |
---|
[189] | 56 | <td><a href="idldoc-categories.html" title="Browse library by category">Categories</a></td> |
---|
[89] | 57 | |
---|
| 58 | |
---|
| 59 | |
---|
[189] | 60 | <td><a href="idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[89] | 61 | |
---|
| 62 | |
---|
| 63 | |
---|
[189] | 64 | <td><a href="search-page.html" title="Search library">Search</a></td> |
---|
[89] | 65 | |
---|
| 66 | |
---|
| 67 | <td >File</td> |
---|
| 68 | |
---|
| 69 | |
---|
[191] | 70 | <td >Source</td> |
---|
[89] | 71 | |
---|
| 72 | |
---|
| 73 | |
---|
| 74 | <td id="selected">Help</td> |
---|
| 75 | |
---|
| 76 | |
---|
| 77 | <td >Etc</td> |
---|
| 78 | |
---|
| 79 | <td id="flexible">Developer documentation</td> |
---|
| 80 | </tr> |
---|
| 81 | </table> |
---|
| 82 | |
---|
| 83 | </div> |
---|
| 84 | |
---|
| 85 | <div id="secondary_navbar"> |
---|
| 86 | |
---|
[189] | 87 | << prev file | next file >> <a href="idldoc-dev-help.html" target="_TOP">view single page</a> | <a href="index.html" target="_TOP">view frames</a> summary: fields | routine details: routine |
---|
[89] | 88 | |
---|
| 89 | </div> |
---|
| 90 | |
---|
| 91 | |
---|
| 92 | <div id="container"> |
---|
| 93 | |
---|
| 94 | <h1>IDLdoc developer's guide</h1> |
---|
| 95 | |
---|
| 96 | <p>This guide discusses how to mark up IDL pro code in order to |
---|
| 97 | insert more information into IDLdoc's output.</p> |
---|
| 98 | |
---|
| 99 | <p>Comments on the routine and file level are placed between |
---|
| 100 | ";+" and ";-" lines before a routine in IDL source code. Content |
---|
| 101 | between these lines is copied verbatim into the IDLdoc output |
---|
| 102 | for the routine it appears before with the exception of the |
---|
| 103 | @-preceded "tags" listed in tables below. Once an @ appears in |
---|
| 104 | the comments, IDLdoc processes all remaining lines of the |
---|
| 105 | comments as tags. To place a non-tag defining "@" in your |
---|
| 106 | comments, escape it with a "\", as in |
---|
| 107 | "email_address\@rsinc.com".</p> |
---|
| 108 | |
---|
| 109 | <p>In the following example, the @author tag is used to indicate |
---|
| 110 | an author of the code. The second "@" is escaped to allow its |
---|
| 111 | literal use in the email address:</p> |
---|
| 112 | |
---|
| 113 | <pre class="snippet">; @author Michael Galloy, mgalloy\@rsinc.com</pre> |
---|
| 114 | |
---|
| 115 | <h2>Routine level comments</h2> |
---|
| 116 | |
---|
| 117 | <p>There are many tags which describe an individual |
---|
| 118 | routine. Each tag name appears after an "@" sign as the first |
---|
| 119 | non-whitespace character after the ;. The tags are described |
---|
| 120 | below.</p> |
---|
| 121 | |
---|
| 122 | <table class="basic" cellspacing="0"> |
---|
| 123 | <tr> |
---|
| 124 | <th>Tag</th> |
---|
| 125 | <th>Description</th> |
---|
| 126 | </tr> |
---|
| 127 | <tr> |
---|
| 128 | <td>abstract</td> |
---|
| 129 | <td> |
---|
| 130 | Presence of the this tag indicates this method is |
---|
| 131 | abstract. This is intended for use with methods of a class |
---|
| 132 | which are not intended to be called, but are only provided |
---|
| 133 | as documenting an interface that a subclass will override. |
---|
| 134 | </td> |
---|
| 135 | </tr> |
---|
| 136 | <tr> |
---|
| 137 | <td>author</td> |
---|
| 138 | <td> |
---|
| 139 | Text following this tag appears in a list of attributes |
---|
| 140 | of the routine marked as "Author." |
---|
| 141 | </td> |
---|
| 142 | </tr> |
---|
| 143 | <tr> |
---|
| 144 | <td>bugs</td> |
---|
| 145 | <td> |
---|
| 146 | Text that follows this tag is copied into a bug |
---|
| 147 | attribute of the routine and placed in a library wide |
---|
| 148 | listing which documents known failings of routines. |
---|
| 149 | </td> |
---|
| 150 | </tr> |
---|
| 151 | <tr> |
---|
| 152 | <td>categories</td> |
---|
| 153 | <td> |
---|
| 154 | Text following this tag is used as a comma separated list |
---|
| 155 | of categories of the routine. The syntax is: |
---|
| 156 | |
---|
| 157 | <pre class="snippet">; @categories math, input/output</pre> |
---|
| 158 | |
---|
| 159 | Category names are case-sensitive and may contain any |
---|
| 160 | characters except commas (though whitespace at the |
---|
| 161 | beginning and end will be removed). |
---|
| 162 | </td> |
---|
| 163 | </tr> |
---|
| 164 | <tr> |
---|
| 165 | <td>copyright</td> |
---|
| 166 | <td> |
---|
| 167 | Text following this tag appears in a list of attributes |
---|
| 168 | of the routine marked as "Copyright." |
---|
| 169 | </td> |
---|
| 170 | </tr> |
---|
| 171 | <tr> |
---|
| 172 | <td>customer_id</td> |
---|
| 173 | <td> |
---|
| 174 | Text following this tag appears in a list of attributes |
---|
| 175 | of the routine marked as "Customer ID." |
---|
| 176 | </td> |
---|
| 177 | </tr> |
---|
| 178 | <tr> |
---|
| 179 | <td>examples</td> |
---|
| 180 | <td> |
---|
| 181 | Text following this tag is copied into an examples |
---|
| 182 | attribute of the routine; it is intended to have |
---|
| 183 | example code of using the routine. |
---|
| 184 | </td> |
---|
| 185 | </tr> |
---|
| 186 | <tr> |
---|
| 187 | <td>field</td> |
---|
| 188 | <td> |
---|
| 189 | For routines in files that end in "__define", this |
---|
| 190 | provides documentation of a member variable of a |
---|
| 191 | class/structure. The syntax is |
---|
| 192 | |
---|
| 193 | <pre class="snippet">; @field field_name comment</pre> |
---|
| 194 | |
---|
| 195 | where "field" matches one of the structure field names |
---|
| 196 | of the structure type/class being defined. |
---|
| 197 | </td> |
---|
| 198 | </tr> |
---|
| 199 | <tr> |
---|
| 200 | <td>hidden</td> |
---|
| 201 | <td> |
---|
| 202 | Presence of this tag hides this routine in IDLdoc |
---|
| 203 | output. |
---|
| 204 | </td> |
---|
| 205 | </tr> |
---|
| 206 | <tr> |
---|
| 207 | <td>history</td> |
---|
| 208 | <td> |
---|
| 209 | Text following this tag is copied into a history |
---|
| 210 | attribute of the routine; it is intended to have a |
---|
| 211 | history of the creators and modifiers of the source |
---|
| 212 | code of the routine. |
---|
| 213 | </td> |
---|
| 214 | </tr> |
---|
| 215 | <tr> |
---|
| 216 | <td>inherits</td> |
---|
| 217 | <td> |
---|
| 218 | Obsolete. Intended to provide the parent class of the |
---|
| 219 | documented class, but this is automatically handled by |
---|
| 220 | IDLdoc now (as long as class definitions are in files |
---|
| 221 | that end "__define"). |
---|
| 222 | </td> |
---|
| 223 | </tr> |
---|
| 224 | <tr> |
---|
| 225 | <td>keyword</td> |
---|
| 226 | <td> |
---|
| 227 | This tag documents a single keyword parameter to the |
---|
| 228 | routine. This syntax is |
---|
| 229 | |
---|
| 230 | <pre class="snippet">; @keyword keyword_name attributes comment</pre> |
---|
| 231 | |
---|
| 232 | Attributes further describe keyword and detailed in |
---|
| 233 | the section below. The comment may be an text and is |
---|
| 234 | copied into the IDLdoc output. |
---|
| 235 | </td> |
---|
| 236 | </tr> |
---|
| 237 | <tr> |
---|
| 238 | <td>obsolete</td> |
---|
| 239 | <td> |
---|
| 240 | Presence of this tag marks the routine as obsolete. |
---|
| 241 | </td> |
---|
| 242 | </tr> |
---|
| 243 | <tr> |
---|
| 244 | <td>param</td> |
---|
| 245 | <td> |
---|
| 246 | This tag documents a single keyword parameter to the |
---|
| 247 | routine. This syntax is |
---|
| 248 | |
---|
| 249 | <pre class="snippet">; @param keyword_name attributes comment</pre> |
---|
| 250 | |
---|
| 251 | Attributes further describe keyword and detailed in |
---|
| 252 | the section below. The comment may be an text and is |
---|
| 253 | copied into the IDLdoc output. |
---|
| 254 | </td> |
---|
| 255 | </tr> |
---|
| 256 | <tr> |
---|
| 257 | <td>pre</td> |
---|
| 258 | <td> |
---|
| 259 | Text following this tag will be copied to a pre |
---|
| 260 | attribute of the routine; it is intended to give |
---|
| 261 | conditions the routine assumes to be true before it |
---|
| 262 | runs. |
---|
| 263 | </td> |
---|
| 264 | </tr> |
---|
| 265 | <tr> |
---|
| 266 | <td>post</td> |
---|
| 267 | <td> |
---|
| 268 | Text following this tag will be copied to a post |
---|
| 269 | attribute of the routine; it is intended to give |
---|
| 270 | conditions the routine assumes to be true after it |
---|
| 271 | runs. |
---|
| 272 | </td> |
---|
| 273 | </tr> |
---|
| 274 | <tr> |
---|
| 275 | <td>private</td> |
---|
| 276 | <td> |
---|
| 277 | Presence of this tag will hide this routine in IDLdoc |
---|
| 278 | output if IDLdoc is run in "user" mode. |
---|
| 279 | </td> |
---|
| 280 | </tr> |
---|
| 281 | <tr> |
---|
| 282 | <td>requires</td> |
---|
| 283 | <td> |
---|
| 284 | Text following this tag is copied into the "Requires" |
---|
| 285 | attribute of the routine; it is intended to provide |
---|
| 286 | the version of IDL required to run the routine. For |
---|
| 287 | example, |
---|
| 288 | |
---|
| 289 | <pre class="snippet">; @requires IDL 6.2</pre> |
---|
| 290 | |
---|
| 291 | will simply cause "IDL 6.2" to appear in the |
---|
| 292 | "Requires" attribute. |
---|
| 293 | </td> |
---|
| 294 | </tr> |
---|
| 295 | <tr> |
---|
| 296 | <td>restrictions</td> |
---|
| 297 | <td> |
---|
| 298 | Text following this tag is copied into the |
---|
| 299 | "Restrictions" attribute of the routine; it is |
---|
| 300 | intended to provide any restrictions on the use of the |
---|
| 301 | routine. |
---|
| 302 | </td> |
---|
| 303 | </tr> |
---|
| 304 | <tr> |
---|
| 305 | <td>returns</td> |
---|
| 306 | <td> |
---|
| 307 | Text following this tag is copied into the "Returns" |
---|
| 308 | attribute of the routine; it is intended to provide |
---|
| 309 | information about return value of a function. |
---|
| 310 | </td> |
---|
| 311 | </tr> |
---|
| 312 | <tr> |
---|
| 313 | <td>todo</td> |
---|
| 314 | <td> |
---|
| 315 | This tag places an item in a library-wide list of todo |
---|
| 316 | items. The text following the tag is copied into this list |
---|
| 317 | along with the routine it appears in it. |
---|
| 318 | </td> |
---|
| 319 | </tr> |
---|
| 320 | <tr> |
---|
| 321 | <td>uses</td> |
---|
| 322 | <td> |
---|
| 323 | Text following this tag is placed in a uses attribute of |
---|
| 324 | the routine; it is intended to list routines that this |
---|
| 325 | routine calls. |
---|
| 326 | </td> |
---|
| 327 | </tr> |
---|
| 328 | <tr> |
---|
| 329 | <td>version</td> |
---|
| 330 | <td> |
---|
| 331 | Text following this tag is placed in a version attribute |
---|
| 332 | of the routine; it is intended to give a version |
---|
| 333 | name/number of the routine. |
---|
| 334 | </td> |
---|
| 335 | </tr> |
---|
| 336 | </table> |
---|
| 337 | |
---|
| 338 | <p>For each positional parameters or keyword tag additional |
---|
| 339 | attributes may be added in curly braces. For example,</p> |
---|
| 340 | |
---|
| 341 | <pre class="snippet">; @param x {in}{required}{type=lonarr} x-axis data</pre> |
---|
| 342 | |
---|
| 343 | <p>The attributes are described below.</p> |
---|
| 344 | |
---|
| 345 | <table class="basic" cellspacing="0"> |
---|
| 346 | <tr> |
---|
| 347 | <th>Attribute</th> |
---|
| 348 | <th>Description</th> |
---|
| 349 | </tr> |
---|
| 350 | <tr> |
---|
| 351 | <td>default</td> |
---|
| 352 | <td> |
---|
| 353 | This atrribute defines the default value of the |
---|
| 354 | parameter. Any string may be entered and is echoed in the |
---|
| 355 | IDLdoc output. |
---|
| 356 | </td> |
---|
| 357 | </tr> |
---|
| 358 | <tr> |
---|
| 359 | <td>hidden</td> |
---|
| 360 | <td> |
---|
| 361 | This attribute hides this parameter in IDLdoc output. |
---|
| 362 | </td> |
---|
| 363 | </tr> |
---|
| 364 | <tr> |
---|
| 365 | <td>in</td> |
---|
| 366 | <td> |
---|
| 367 | This attribute marks the parameter as an input to the |
---|
| 368 | routine. |
---|
| 369 | </td> |
---|
| 370 | </tr> |
---|
| 371 | <tr> |
---|
| 372 | <td>optional</td> |
---|
| 373 | <td> |
---|
| 374 | This attribute marks the parameter as optional; the |
---|
| 375 | routine does not always need this parameter, although |
---|
| 376 | there might be cases where the parameter is required |
---|
| 377 | (depending on the presence and value of other parameters). |
---|
| 378 | </td> |
---|
| 379 | </tr> |
---|
| 380 | <tr> |
---|
| 381 | <td>out</td> |
---|
| 382 | <td> |
---|
| 383 | This attribute marks the parameter as an output to the |
---|
| 384 | routine. This routine expects a named variable to be |
---|
| 385 | passed to this parameter (if passed at all). |
---|
| 386 | </td> |
---|
| 387 | </tr> |
---|
| 388 | <tr> |
---|
| 389 | <td>private</td> |
---|
| 390 | <td> |
---|
| 391 | This attribute hides this parameter in IDLdoc output when |
---|
| 392 | IDLdoc is run in "user" mode and marking it as "private" |
---|
| 393 | when run in "developer" mode. |
---|
| 394 | </td> |
---|
| 395 | </tr> |
---|
| 396 | <tr> |
---|
| 397 | <td>required</td> |
---|
| 398 | <td> |
---|
| 399 | This attribute marks the parameter as required. |
---|
| 400 | </td> |
---|
| 401 | </tr> |
---|
| 402 | <tr> |
---|
| 403 | <td>type</td> |
---|
| 404 | <td> |
---|
| 405 | This atrribute defines the data type of the |
---|
| 406 | parameter. Any string may be entered and is echoed in |
---|
| 407 | the IDLdoc output. The special type "boolean" will cause |
---|
| 408 | the calling syntax in IDLdoc output to use the IDL |
---|
| 409 | online help syntax of prepending a "/" to the parameter |
---|
| 410 | name. |
---|
| 411 | </td> |
---|
| 412 | </tr> |
---|
| 413 | </table> |
---|
| 414 | |
---|
| 415 | <h2>File level comments</h2> |
---|
| 416 | |
---|
| 417 | <p>Some tags may appear in the comments for any routine in a |
---|
| 418 | file because they document attributes of the file. These tags |
---|
| 419 | are described below.</p> |
---|
| 420 | |
---|
| 421 | <table class="basic" cellspacing="0"> |
---|
| 422 | <tr> |
---|
| 423 | <th>Tag</th> |
---|
| 424 | <th>Description</th> |
---|
| 425 | </tr> |
---|
| 426 | <tr> |
---|
| 427 | <td>file_comments</td> |
---|
| 428 | <td> |
---|
| 429 | Text following the tag is copied to the top of the file |
---|
| 430 | in the IDLdoc output i.e. it is a comment on the file |
---|
| 431 | and not the routine it appears in. If there are multiple |
---|
| 432 | file_comments tags in the file, the comments will be |
---|
| 433 | concatenated in the order they are present in the file. |
---|
| 434 | </td> |
---|
| 435 | </tr> |
---|
| 436 | <tr> |
---|
| 437 | <td>hidden_file</td> |
---|
| 438 | <td> |
---|
| 439 | Presence of this tag indicates this entire file should |
---|
| 440 | be hidden in IDLdoc output. |
---|
| 441 | </td> |
---|
| 442 | </tr> |
---|
| 443 | <tr> |
---|
| 444 | <td>private_file</td> |
---|
| 445 | <td> |
---|
| 446 | Presence of this tag indicates this entire file should |
---|
| 447 | be hidden in IDLdoc output if IDLdoc is run in "user" |
---|
| 448 | mode, but shown when run in "developer" mode (the |
---|
| 449 | default). |
---|
| 450 | </td> |
---|
| 451 | </tr> |
---|
| 452 | </table> |
---|
| 453 | |
---|
| 454 | <h2>Examples</h2> |
---|
| 455 | |
---|
| 456 | For example, here's a sample class definition routine: |
---|
| 457 | |
---|
| 458 | <pre class="snippet">;+ |
---|
| 459 | ; Define the instance variables of the array_list. |
---|
| 460 | ; |
---|
| 461 | ; @file_comments An array_list is an object representing a variable |
---|
| 462 | ; length list of scalar elements of any single type. |
---|
| 463 | ; Array_lists support adding elements at the end of |
---|
| 464 | ; the vector only, but any element may be removed from |
---|
| 465 | ; the array_list. An iterator is provided for |
---|
| 466 | ; efficient and easy looping throught the elements of |
---|
| 467 | ; the array_list. |
---|
| 468 | ; |
---|
| 469 | ; @field data pointer to an array |
---|
| 470 | ; @field cur_size the current size of the data in the array |
---|
| 471 | ; @field max_size the maximum size of the data in the current array |
---|
| 472 | ; @field type type code (as in SIZE function) for the elements in the |
---|
| 473 | ; array_list |
---|
| 474 | ; @field sample_struct pointer to a structure if the type is |
---|
| 475 | ; "structure" |
---|
| 476 | ; @field iterators IDL_Container for the iterators of this array_list |
---|
| 477 | ; |
---|
| 478 | ; @requires IDL 6.0 |
---|
| 479 | ; |
---|
| 480 | ; @author Michael D. Galloy |
---|
| 481 | ; @history Created September 26, 2003 |
---|
| 482 | ; @copyright RSI, 2003 |
---|
| 483 | ;- |
---|
| 484 | pro array_list__define |
---|
| 485 | compile_opt idl2 |
---|
| 486 | |
---|
| 487 | define = { array_list, $ |
---|
| 488 | data:ptr_new(), $ |
---|
| 489 | cur_size:0L, $ |
---|
| 490 | max_size:0L, $ |
---|
| 491 | type:0L, $ |
---|
| 492 | sample_struct:ptr_new(), $ |
---|
| 493 | iterators:obj_new() $ |
---|
| 494 | } |
---|
| 495 | end</pre> |
---|
| 496 | |
---|
| 497 | Another example routine, this time a simple function with a positional parameter and keyword: |
---|
| 498 | |
---|
| 499 | <pre class="snippet">;+ |
---|
| 500 | ; Returns [b, a] for a linear function y = a * x + b that sends |
---|
| 501 | ; inRange[0] -> range[0] and inRange[1] -> range[1]. |
---|
| 502 | ; |
---|
| 503 | ; @returns dblarr(2) |
---|
| 504 | ; @param inRange {in}{required}{type=2 element numeric array} input |
---|
| 505 | ; range |
---|
| 506 | ; @keyword range {in}{optional}{type=dblarr(2)}{default=[0.D, 1.D]} |
---|
| 507 | ; output range |
---|
| 508 | ; @categories math, object graphics |
---|
| 509 | ;- |
---|
| 510 | function linear_function, inRange, range=outRange |
---|
| 511 | compile_opt idl2 |
---|
| 512 | |
---|
| 513 | i_outRange = n_elements(outRange) eq 0 $ |
---|
| 514 | ? [0.D, 1.D] $ |
---|
| 515 | : double(outRange) |
---|
| 516 | |
---|
| 517 | scale = [i_outRange[0] * inRange[1] - i_outRange[1] * inRange[0], $ |
---|
| 518 | i_outRange[1] - i_outRange[0]] / (inRange[1] - inRange[0]) |
---|
| 519 | return, scale |
---|
| 520 | end</pre> |
---|
| 521 | |
---|
| 522 | One more example, this time a function method with an output keyword. |
---|
| 523 | |
---|
| 524 | <pre class="snippet">;+ |
---|
| 525 | ; Finds the value associated with the given key. |
---|
| 526 | ; |
---|
| 527 | ; @returns the value of the associated key or -1L if not found |
---|
| 528 | ; @param key {in}{type=key type} key to look up |
---|
| 529 | ; @keyword found {out}{optional}{type=boolean} true if value found for |
---|
| 530 | ; given key |
---|
| 531 | ;- |
---|
| 532 | function hash_table::get, key, found=found</pre> |
---|
| 533 | |
---|
| 534 | <h2>Directory overviews</h2> |
---|
| 535 | |
---|
| 536 | <p>The "dir-overview" file in each directory of the library is |
---|
| 537 | copied into the directory overview file. Much of the content of |
---|
| 538 | the overview file is obtained from the PRO code files in the |
---|
| 539 | directory, but this allows header content as an overview of the |
---|
| 540 | all the files in the directory to be inserted at the top of the |
---|
| 541 | directory overview file.</p> |
---|
| 542 | |
---|
| 543 | |
---|
| 544 | <h2>Library overview</h2> |
---|
| 545 | |
---|
| 546 | <p>The library overview file is a single file which is inserted |
---|
| 547 | into the opening page of the IDLdoc output. This file is copied |
---|
| 548 | verbatim into the IDLdoc output except for the following tag |
---|
| 549 | which allows for comments on the contents of the directories |
---|
| 550 | found in the library.</p> |
---|
| 551 | |
---|
| 552 | <table class="basic" cellspacing="0"> |
---|
| 553 | <tr> |
---|
| 554 | <th>Tag</th> |
---|
| 555 | <th>Description</th> |
---|
| 556 | </tr> |
---|
| 557 | <tr> |
---|
| 558 | <td>dir</td> |
---|
| 559 | <td> |
---|
| 560 | The text following this tag is the relative path |
---|
| 561 | (web-style, always with a /) to a directory in the |
---|
| 562 | library and a comment which is copied into a table in |
---|
| 563 | the opening page of the IDLdoc output. |
---|
| 564 | |
---|
| 565 | <pre class="snippet">; @dir algorithms/math mathematical routines</pre> |
---|
| 566 | </td> |
---|
| 567 | </tr> |
---|
| 568 | </table> |
---|
| 569 | |
---|
| 570 | <h2>Syntax of IDLdoc routine</h2> |
---|
| 571 | |
---|
| 572 | <p>Below is the IDLdoc generated documentation for the IDLdoc main routine.</p> |
---|
| 573 | |
---|
| 574 | <div class="routine_details" id="_idldoc"> |
---|
| 575 | |
---|
| 576 | <h2><a class="top" href="#container">top</a>idldoc</h2> |
---|
| 577 | |
---|
| 578 | <p class="header"> |
---|
| 579 | idldoc, <a href="#_idldoc_keyword_root">root</a>=<span class="result">string</span>[, <a href="#_idldoc_keyword_output">output</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_overview">overview</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_footer">footer</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_log_file">log_file</a>=<span class="result">string</span>][, /<a href="#_idldoc_keyword_user">user</a>][, /<a href="#_idldoc_keyword_quiet">quiet</a>][, /<a href="#_idldoc_keyword_silent">silent</a>][, /<a href="#_idldoc_keyword_embed">embed</a>][, /<a href="#_idldoc_keyword_nonavbar">nonavbar</a>][, <a href="#_idldoc_keyword_title">title</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_subtitle">subtitle</a>=<span class="result">string</span>][, /<a href="#_idldoc_keyword_statistics">statistics</a>][, <a href="#_idldoc_keyword_n_warnings">n_warnings</a>=<span class="result">variable</span>][, /<a href="#_idldoc_keyword_browse_routines">browse_routines</a>][, /<a href="#_idldoc_keyword_preformat">preformat</a>][, /<a href="#_idldoc_keyword_assistant">assistant</a>]</p> |
---|
| 580 | |
---|
| 581 | <div class="comments">Calling routine for IDLdoc.</div> |
---|
| 582 | |
---|
| 583 | <h3>Keywords</h3> |
---|
| 584 | |
---|
| 585 | <h4 id="_idldoc_keyword_root">root |
---|
| 586 | <span class="attr">in</span> |
---|
| 587 | <span class="attr">required</span> |
---|
| 588 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 589 | </h4> |
---|
| 590 | |
---|
| 591 | <div class="comments"> root directory for IDLdoc's |
---|
| 592 | recursive search for .pro files. IDLdoc will find any |
---|
| 593 | files with the '.pro' suffix and include them in its file |
---|
| 594 | listings. Only directories with '.pro' files in them are |
---|
| 595 | included in the directory listings.</div> |
---|
| 596 | |
---|
| 597 | <h4 id="_idldoc_keyword_output">output |
---|
| 598 | <span class="attr">in</span> |
---|
| 599 | <span class="attr">optional</span> |
---|
| 600 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 601 | <span class="attr">default:</span> <span class="value">same as root</span> |
---|
| 602 | </h4> |
---|
| 603 | |
---|
| 604 | <div class="comments"> |
---|
| 605 | directory in which to create the HTML output and possible |
---|
| 606 | subdirectories</div> |
---|
| 607 | |
---|
| 608 | <h4 id="_idldoc_keyword_overview">overview |
---|
| 609 | <span class="attr">in</span> |
---|
| 610 | <span class="attr">optional</span> |
---|
| 611 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 612 | </h4> |
---|
| 613 | |
---|
| 614 | <div class="comments"> filepath to a file containing the |
---|
| 615 | summary of the package information about each directory in |
---|
| 616 | the package.</div> |
---|
| 617 | |
---|
| 618 | <h4 id="_idldoc_keyword_footer">footer |
---|
| 619 | <span class="attr">in</span> |
---|
| 620 | <span class="attr">optional</span> |
---|
| 621 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 622 | </h4> |
---|
| 623 | |
---|
| 624 | <div class="comments"> filename for a footer to be placed |
---|
| 625 | at the bottom of files; this file can contain any valid |
---|
| 626 | HTML</div> |
---|
| 627 | |
---|
| 628 | <h4 id="_idldoc_keyword_log_file">log_file |
---|
| 629 | <span class="attr">in</span> |
---|
| 630 | <span class="attr">optional</span> |
---|
| 631 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 632 | </h4> |
---|
| 633 | |
---|
| 634 | <div class="comments"> set to a filename of a file to |
---|
| 635 | contain the error messages generated by the IDLdoc run; |
---|
| 636 | useful for automated runs of IDLdoc</div> |
---|
| 637 | |
---|
| 638 | <h4 id="_idldoc_keyword_user">user |
---|
| 639 | <span class="attr">in</span> |
---|
| 640 | <span class="attr">optional</span> |
---|
| 641 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 642 | </h4> |
---|
| 643 | |
---|
| 644 | <div class="comments"> set to create a listing appropriate |
---|
| 645 | for <em>users</em> of the given library hierarchy; the |
---|
| 646 | default is to create documentation suited to developers. |
---|
| 647 | If set private routines are not shown in the |
---|
| 648 | documentation.</div> |
---|
| 649 | |
---|
| 650 | <h4 id="_idldoc_keyword_quiet">quiet |
---|
| 651 | <span class="attr">in</span> |
---|
| 652 | <span class="attr">optional</span> |
---|
| 653 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 654 | </h4> |
---|
| 655 | |
---|
| 656 | <div class="comments"> if set, print only |
---|
| 657 | warnings</div> |
---|
| 658 | |
---|
| 659 | <h4 id="_idldoc_keyword_silent">silent |
---|
| 660 | <span class="attr">in</span> |
---|
| 661 | <span class="attr">optional</span> |
---|
| 662 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 663 | </h4> |
---|
| 664 | |
---|
| 665 | <div class="comments"> if set, print no |
---|
| 666 | messages</div> |
---|
| 667 | |
---|
| 668 | <h4 id="_idldoc_keyword_embed">embed |
---|
| 669 | <span class="attr">in</span> |
---|
| 670 | <span class="attr">optional</span> |
---|
| 671 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 672 | </h4> |
---|
| 673 | |
---|
| 674 | <div class="comments"> if set, embeds style sheet in each |
---|
| 675 | HTML document; if this is not set, each HTML file will be |
---|
| 676 | looking for the cascading style sheet idldoc.css in the |
---|
| 677 | directory specified for the ROOT keyword</div> |
---|
| 678 | |
---|
| 679 | <h4 id="_idldoc_keyword_nonavbar">nonavbar |
---|
| 680 | <span class="attr">in</span> |
---|
| 681 | <span class="attr">optional</span> |
---|
| 682 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 683 | </h4> |
---|
| 684 | |
---|
| 685 | <div class="comments"> set to exclude the |
---|
| 686 | navigation bar at the top of each page</div> |
---|
| 687 | |
---|
| 688 | <h4 id="_idldoc_keyword_title">title |
---|
| 689 | <span class="attr">in</span> |
---|
| 690 | <span class="attr">optional</span> |
---|
| 691 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 692 | <span class="attr">default:</span> <span class="value">Research Systems</span> |
---|
| 693 | </h4> |
---|
| 694 | |
---|
| 695 | <div class="comments"> title of |
---|
| 696 | the library</div> |
---|
| 697 | |
---|
| 698 | <h4 id="_idldoc_keyword_subtitle">subtitle |
---|
| 699 | <span class="attr">in</span> |
---|
| 700 | <span class="attr">optional</span> |
---|
| 701 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 702 | <span class="attr">default:</span> <span class="value">IDL version</span> |
---|
| 703 | </h4> |
---|
| 704 | |
---|
| 705 | <div class="comments"> subtitle of |
---|
| 706 | the library</div> |
---|
| 707 | |
---|
| 708 | <h4 id="_idldoc_keyword_statistics">statistics |
---|
| 709 | <span class="attr">in</span> |
---|
| 710 | <span class="attr">optional</span> |
---|
| 711 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 712 | </h4> |
---|
| 713 | |
---|
| 714 | <div class="comments"> set to calculate several |
---|
| 715 | McCabe statistics for each routine</div> |
---|
| 716 | |
---|
| 717 | <h4 id="_idldoc_keyword_n_warnings">n_warnings |
---|
| 718 | <span class="attr">out</span> |
---|
| 719 | <span class="attr">optional</span> |
---|
| 720 | <span class="attr">type:</span> <span class="value">integer</span> |
---|
| 721 | </h4> |
---|
| 722 | |
---|
| 723 | <div class="comments"> set to a named variable to |
---|
| 724 | contain the total number of warnings issued during the run</div> |
---|
| 725 | |
---|
| 726 | <h4 id="_idldoc_keyword_browse_routines">browse_routines |
---|
| 727 | <span class="attr">in</span> |
---|
| 728 | <span class="attr">optional</span> |
---|
| 729 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 730 | </h4> |
---|
| 731 | |
---|
| 732 | <div class="comments"> set to include a frame |
---|
| 733 | to browse through the routines of the current file</div> |
---|
| 734 | |
---|
| 735 | <h4 id="_idldoc_keyword_preformat">preformat |
---|
| 736 | <span class="attr">in</span> |
---|
| 737 | <span class="attr">optional</span> |
---|
| 738 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 739 | </h4> |
---|
| 740 | |
---|
| 741 | <div class="comments"> set to produce output that |
---|
| 742 | will look like it does in the code files (line for line)</div> |
---|
| 743 | |
---|
| 744 | <h4 id="_idldoc_keyword_assistant">assistant |
---|
| 745 | <span class="attr">in</span> |
---|
| 746 | <span class="attr">optional</span> |
---|
| 747 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 748 | </h4> |
---|
| 749 | |
---|
| 750 | <div class="comments"> set to produce output for the |
---|
| 751 | IDL assistant help system instead of optimized for a web browser |
---|
| 752 | </div> |
---|
| 753 | |
---|
[138] | 754 | <h3>Examples</h3><div class="preformat"> To run IDLdoc, try: |
---|
[89] | 755 | <center><code>idldoc, root='C:\mycode'</code></center> |
---|
| 756 | where C:\mycode is the root of a directory tree containing IDL |
---|
| 757 | .pro files. |
---|
| 758 | </div> |
---|
| 759 | |
---|
| 760 | <h3>Version history</h3> |
---|
| 761 | |
---|
[138] | 762 | <h4>Author</h4><div class="preformat"> Michael D. Galloy</div> |
---|
[89] | 763 | |
---|
[138] | 764 | <h4>Copyright</h4><div class="preformat"> RSI, 2002</div> |
---|
[89] | 765 | |
---|
| 766 | <h3>Other attributes</h3> |
---|
| 767 | |
---|
[138] | 768 | <h4>Requires IDL version</h4><div class="preformat"> IDL 6.0</div> |
---|
[89] | 769 | |
---|
| 770 | </div> |
---|
| 771 | |
---|
| 772 | |
---|
| 773 | |
---|
| 774 | |
---|
| 775 | |
---|
| 776 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 777 | |
---|
| 778 | </div> |
---|
| 779 | |
---|
| 780 | </body> |
---|
[249] | 781 | </html> |
---|