[60] | 1 | <H1>Help on IDLdoc output</H1> |
---|
| 2 | |
---|
| 3 | <H2>Routine summary</H2> |
---|
| 4 | |
---|
| 5 | The routine summary simply provides the calling sequence for each routine in |
---|
| 6 | the file and the first sentence of the detailed description. |
---|
| 7 | |
---|
| 8 | <H2>Routine Details</H2> |
---|
| 9 | |
---|
| 10 | The routine details sections gives a possibly longer description of the routine |
---|
| 11 | as well as a tables of the parameters and keywords accepted by the routine. |
---|
| 12 | |
---|
| 13 | All the parameters and keywords of the routine will be in these tables |
---|
| 14 | regardless if they have been commented using IDLdoc. |
---|
| 15 | |
---|
| 16 | <H3>Notes on routine attributes</H3> |
---|
| 17 | |
---|
| 18 | See the IDLdoc page for IDLdoc itself for a full listing of the attributes of |
---|
| 19 | a routine. |
---|
| 20 | |
---|
| 21 | <P> |
---|
| 22 | |
---|
| 23 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="minor_listing"> |
---|
| 24 | <TR bgcolor="#EEEEFF"> |
---|
| 25 | <TD width="1%" valign="top"><B>Attribute</B></TD> |
---|
| 26 | <TD><B>Description</B></TD> |
---|
| 27 | </TR> |
---|
| 28 | <TR> |
---|
| 29 | <TD valign="top">abstract</TD> |
---|
| 30 | <TD>The routine name will be italicized if the routine is marked |
---|
| 31 | "abstract" (meaning it is not implemented, it is provided for its |
---|
| 32 | interface). This is generally used in only object-oriented |
---|
| 33 | programming. |
---|
| 34 | </TD> |
---|
| 35 | </TR> |
---|
| 36 | <TR> |
---|
| 37 | <TD valign="top">private</TD> |
---|
| 38 | <TD>This routine is not intended to be called except by other routines |
---|
| 39 | in the same file. In other words it is a "helper routine". |
---|
| 40 | </TD> |
---|
| 41 | </TR> |
---|
| 42 | </TABLE> |
---|
| 43 | |
---|
| 44 | |
---|
| 45 | <H3>Keyword and parameter attributes</H3> |
---|
| 46 | |
---|
| 47 | <TABLE CELLPADDING="3" CELLSPACING="0" CLASS="minor_listing"> |
---|
| 48 | <TR bgcolor="#EEEEFF"> |
---|
| 49 | <TD width="1%" valign="top"><B>Attribute</B></TD> |
---|
| 50 | <TD><B>Description</B></TD> |
---|
| 51 | </TR> |
---|
| 52 | <TR> |
---|
| 53 | <TD valign="top">in</TD> |
---|
| 54 | <TD>indicates that the argument is intended to be passed into the |
---|
| 55 | routine. |
---|
| 56 | </TD> |
---|
| 57 | </TR> |
---|
| 58 | <TR> |
---|
| 59 | <TD valign="top">out</TD> |
---|
| 60 | <TD>indicates that the argument is intended to be used to pass a value |
---|
| 61 | out of the routine. A named variable must be passed to the routine |
---|
| 62 | to pass a value back to the calling level. |
---|
| 63 | </TD> |
---|
| 64 | </TR> |
---|
| 65 | <TR> |
---|
| 66 | <TD valign="top">optional</TD> |
---|
| 67 | <TD>indicates the argument is optional; optional parameters and keywords |
---|
| 68 | are also placed inside brackets ([]) in the routine summary. |
---|
| 69 | </TD> |
---|
| 70 | </TR> |
---|
| 71 | <TR> |
---|
| 72 | <TD valign="top">required</TD> |
---|
| 73 | <TD>indicates the argument is required</TD> |
---|
| 74 | </TR> |
---|
| 75 | <TR> |
---|
| 76 | <TD valign="top">type</TD> |
---|
| 77 | <TD>"type" indicates the type of the variable. Can be used indicate a |
---|
| 78 | group of types, a specific type, an array of a certain type, etc. |
---|
| 79 | Boolean keywords are indicated by a /KEYWORD_NAME in the routine |
---|
| 80 | summary. |
---|
| 81 | </TD> |
---|
| 82 | </TR> |
---|
| 83 | </TABLE> |
---|
| 84 | |
---|
| 85 | <P> |
---|