Changeset 692

Show
Ignore:
Timestamp:
09/07/10 13:07:06 (21 months ago)
Author:
mgalloy
Message:

Adding to tutorial and reference. Adding titles to tables in reference guide.

Location:
trunk/reference
Files:
2 modified

Legend:

Unmodified
Added
Removed

  • trunk/reference/idldoc-reference.rst

    r691 r692  
    44:Author: Michael Galloy 
    55 
     6:Abstract: This reference guide simply lists options available for running IDLdoc and documenting code. See the tutorial for a more friendly introduction to using IDLdoc. 
     7 
    68 
    79IDLdoc installation 
    … …  
    1618There are quite a few keywords to IDLdoc to set various specifications for the output. Also see the "Customizing Output" section for using templates for customized output. 
    1719 
    18 =================== ======================================================== 
    19 Keyword             Description 
    20 =================== ======================================================== 
    21 `ASSISTANT`         obsolete; no longer used 
    22 `BROWSE_ROUTINES`   obsolete; no longer used 
    23 `CHARSET`           set to the character set to be used for the output,  
    24                     default is "utf-8" 
    25 `COMMENT_STYLE`     output format for comments ("html", "rst", or "latex");  
    26                     default is "html" 
    27 `DEBUG`             set to allow crashes with a stack trace instead of the  
    28                     default simple message 
    29 `EMBED`             embed CSS stylesheet instead of linking to it (useful for  
    30                     documentation where individual pages must stand by  
    31                     themselves) 
    32 `ERROR`             set to a named variable to return the error state of the  
    33                     IDLdoc call; 0 indicates no error, anything else is an  
    34                     error 
    35 `FOOTER`            filename of file to insert into the bottom of each page of  
    36                     docs 
    37 `FORMAT_STYLE`      style to use to parse file and routine comments ("idl", 
    38                     "idldoc", "verbatim", or "rst"); default is "idldoc" 
    39 `HELP`              set to print out the syntax of an IDLdoc call 
    40 `LOG_FILE`          if present, send messages to this filename instead of  
    41                     *stdout* 
    42 `MARKUP_STYLE`      markup used in comments ("rst" or "verbatim"); default is 
    43                     "verbatim" 
    44 `N_WARNINGS`        set to a named variable to return the number of warnings  
    45                     for the IDLdoc run 
    46 `NONAVBAR`          set to not display the navbar 
    47 `NOSOURCE`          set to not put source code into output 
    48 `OUTPUT`            directory to place output; if not present, output will be  
    49                     placed in the `ROOT` directory            
    50 `OVERVIEW`          filename of overview text and directory information 
    51 `PREFORMAT`         obsolete; no longer used 
    52 `QUIET`             if set, don't print info messages, only print warnings and  
    53                     errors 
    54 `ROOT`              root of directory hierarchy to document; this is the only  
    55                     required keyword 
    56 `SILENT`            if set, don't print any messages 
    57 `STATISTICS`        set to generate complexity statistics for routines 
    58 `SUBTITLE`          subtitle for docs 
    59 `TEMPLATE_PREFIX`   prefix for template's names 
    60 `TEMPLATE_LOCATION` set to directory to find templates in 
    61 `TITLE`             title of docs 
    62 `USER`              set to generate user-level docs (private parameters, files  
    63                     are not shown); the default is developer-level docs  
    64                     showing files and parameters 
    65 `VERSION`           set to print out the version of IDLdoc 
    66 =================== ======================================================== 
     20.. table:: Keywords for the `IDLDOC` routine 
     21 
     22  =================== ======================================================== 
     23  Keyword             Description 
     24  =================== ======================================================== 
     25  `ASSISTANT`         obsolete; no longer used 
     26  `BROWSE_ROUTINES`   obsolete; no longer used 
     27  `CHARSET`           set to the character set to be used for the output,  
     28                      default is "utf-8" 
     29  `COMMENT_STYLE`     output format for comments ("html", "rst", or "latex");  
     30                      default is "html" 
     31  `DEBUG`             set to allow crashes with a stack trace instead of the  
     32                      default simple message 
     33  `EMBED`             embed CSS stylesheet instead of linking to it (useful  
     34                      for documentation where individual pages must stand by  
     35                      themselves) 
     36  `ERROR`             set to a named variable to return the error state of the  
     37                      IDLdoc call; 0 indicates no error, anything else is an  
     38                      error 
     39  `FOOTER`            filename of file to insert into the bottom of each page  
     40                      of docs 
     41  `FORMAT_STYLE`      style to use to parse file and routine comments ("idl", 
     42                      "idldoc", "verbatim", or "rst"); default is "idldoc" 
     43  `HELP`              set to print out the syntax of an IDLdoc call 
     44  `LOG_FILE`          if present, send messages to this filename instead of  
     45                      *stdout* 
     46  `MARKUP_STYLE`      markup used in comments ("rst" or "verbatim"); default  
     47                      is "verbatim" unless `FORMAT_STYLE` is set to "rst", in  
     48                      which case, the default is "rst" 
     49  `N_WARNINGS`        set to a named variable to return the number of warnings  
     50                      for the IDLdoc run 
     51  `NONAVBAR`          set to not display the navbar 
     52  `NOSOURCE`          set to not put source code into output 
     53  `OUTPUT`            directory to place output; if not present, output will  
     54                      be placed in the `ROOT` directory            
     55  `OVERVIEW`          filename of overview text and directory information 
     56  `PREFORMAT`         obsolete; no longer used 
     57  `QUIET`             if set, don't print info messages, only print warnings  
     58                      and errors 
     59  `ROOT`              root of directory hierarchy to document; this is the  
     60                      only required keyword 
     61  `SILENT`            if set, don't print any messages 
     62  `STATISTICS`        set to generate complexity statistics for routines 
     63  `SUBTITLE`          subtitle for docs 
     64  `TEMPLATE_PREFIX`   prefix for template's names 
     65  `TEMPLATE_LOCATION` set to directory to find templates in 
     66  `TITLE`             title of docs 
     67  `USER`              set to generate user-level docs (private parameters,  
     68                      files are not shown); the default is developer-level  
     69                      docs showing files and parameters 
     70  `VERSION`           set to print out the version of IDLdoc 
     71  =================== ======================================================== 
    6772 
    6873 
    … …  
    7782The following tags are available in file comments (i.e. comment headers not immediately preceeding/following a routine header). 
    7883 
    79 ============== ============ ============ ==================================== 
    80 Tag name       Arguments    Attributes   Description 
    81 ============== ============ ============ ==================================== 
    82 `:Author:`     comments     none         specifies the author of the file 
    83 `:Copyright:`  comments     none         specifies the copyright information  
    84                                          for the file 
    85 `:Examples:`   comments     none         specifies examples of usage 
    86 `:Hidden:`     none         none         if present, indicates the file is not   
    87                                          to be shown in the documentation 
    88 `:History:`    comments     none         lists the history for the file 
    89 `:Private:`    none         none         if present, indicates the file should  
    90                                          not shown in user-level documentation  
    91                                          (set with the `USER` keyword to  
    92                                          IDLdoc) 
    93 `:Properties:` property     none         describes properties of a class,                                           
    94                name,                     i.e., a keyword to `getProperty`,  
    95                comments                  `setProperty`, or `init` 
    96 `:Version:`    comments     none         specifies the version of the file 
    97 ============== ============ ============ ==================================== 
    98  
    99  
    100 The following tags are available for comments immediately before or after a routine header. 
    101  
    102 ================= ============ ========== ================================= 
    103 Tag name          Arguments    Attributes Description 
    104 ================= ============ ========== ================================= 
    105 `:Abstract:`      none         none       if present, indicates the method is  
    106                                           not implemented and present only to  
    107                                           specify the interface to subclasses'  
    108                                           implementations 
    109 `:Author:`        comments     none       specifies the author of the routine 
    110 `:Bugs:`          comments     none       specifies any issues found in the  
    111                                           routine 
    112 `:Categories:`    list         none       specifies a comma-separated list of  
    113                                           category names 
    114 `:Copyright:`     comments     none       specifies the copyright for the  
    115                                           routine 
    116 `:Customer_id:`   comments     none       specifies a customer ID for the  
    117                                           routine 
    118 `:Description:`   comments     none       a tag for the standard comments for  
    119                                           a routine; will be appended to  
    120                                           standard comments if both are  
    121                                           present 
    122 `:Examples:`      comments     none       specifies examples of using the  
    123                                           routine 
    124 `:Fields:`        fieldname    none       specifies the names of the field  
    125                   and comments            followed by a description of the  
    126                                           field 
    127 `:File_comments:` comments     none       equivalent to the main section in  
    128                                           file-level comments 
    129 `:Hidden:`        none         none       if present, indicate the routine  
    130                                           should not be shown in the  
    131                                           documentation 
    132 `:Hidden_file:`   none         none       if present, indicates the file  
    133                                           containing this routine should not  
    134                                           be shown in the documentation 
    135 `:History:`       comments     none       specifies the history of the  
    136                                           routine 
    137 `:Inherits:`      none         none       not used 
    138 `:Keywords:`      keyword name see below        documents keywords of the routine 
    139 `:Obsolete:`      none         none       if present, indicates the routine is  
    140                                           obsolete 
    141 `:Params:`        param name   see below  documents positional parameters of  
    142                                           the routine 
    143 `:Post:`          comments     none       specifies any post-conditions of the  
    144                                           routine 
    145 `:Pre:`           comments     none       specifies any pre-conditions of the  
    146                                           routine 
    147 `:Private:`       none         none       if present, indicates the routine  
    148                                           should not shown in user-level  
    149                                           documentation (set with the `USER`  
    150                                           keyword to IDLdoc) 
    151 `:Private_file:`  comments     none       if present, indicates the file  
    152                                           containing this routine should not  
    153                                           shown in user-level documentation  
    154                                           (set with the `USER` keyword to  
    155                                           IDLdoc) 
    156 `:Requires:`      comments     none       specifies the IDL version of the  
    157                                           routine; IDLdoc finds the routines  
    158                                           requiring the highest IDL version  
    159                                           and reports them on the warnings  
    160                                           page 
    161 `:Returns:`       comments     none       specifies the return value of the  
    162                                           function 
    163 `:Todo:`          comments     none       specifies any todo items left for  
    164                                           the routine 
    165 `:Uses:`          comments     none       specifies any other routines,  
    166                                           classes, etc. needed by the routine 
    167 `:Version:`       comments     none       specifies the version of the  
    168                                           routine 
    169 ================= ============ ========== ================================= 
    170  
    171  
    172  
    173 overview files tags 
    174  
    175 directory overview file tags 
     84.. table:: rst format style file tags 
     85 
     86  ============== ============ ============ =================================== 
     87  Tag name       Arguments    Attributes   Description 
     88  ============== ============ ============ =================================== 
     89  `:Author:`     comments     none         specifies the author of the file 
     90  `:Copyright:`  comments     none         specifies the copyright information  
     91                                           for the file 
     92  `:Examples:`   comments     none         specifies examples of usage 
     93  `:Hidden:`     none         none         if present, indicates the file is  
     94                                           not to be shown in the  
     95                                           documentation 
     96  `:History:`    comments     none         lists the history for the file 
     97  `:Private:`    none         none         if present, indicates the file  
     98                                           should not shown in user-level  
     99                                           documentation  
     100                                           (set with the `USER` keyword to  
     101                                           IDLdoc) 
     102  `:Properties:` property     none         describes properties of a class,                                           
     103                 name,                     i.e., a keyword to `getProperty`,  
     104                 comments                  `setProperty`, or `init` 
     105  `:Version:`    comments     none         specifies the version of the file 
     106  ============== ============ ============ =================================== 
     107 
     108 
     109The following tags are available for comments immediately preceding or following a routine header. 
     110 
     111.. table:: rst format style routine tags 
     112 
     113  ================= ============ ========== ================================= 
     114  Tag name          Arguments    Attributes Description 
     115  ================= ============ ========== ================================= 
     116  `:Abstract:`      none         none       if present, indicates the method  
     117                                            is not implemented and present  
     118                                            only to specify the interface to  
     119                                            subclasses'  
     120                                            implementations 
     121  `:Author:`        comments     none       specifies the author of the  
     122                                            routine 
     123  `:Bugs:`          comments     none       specifies any issues found in the  
     124                                            routine 
     125  `:Categories:`    list         none       specifies a comma-separated list  
     126                                            of category names 
     127  `:Copyright:`     comments     none       specifies the copyright for the  
     128                                            routine 
     129  `:Customer_id:`   comments     none       specifies a customer ID for the  
     130                                            routine 
     131  `:Description:`   comments     none       a tag for the standard comments  
     132                                            for a routine; will be appended to  
     133                                            standard comments if both are  
     134                                            present 
     135  `:Examples:`      comments     none       specifies examples of using the  
     136                                            routine 
     137  `:Fields:`        fieldname    none       specifies the names of the field  
     138                    and comments            followed by a description of the  
     139                                            field 
     140  `:File_comments:` comments     none       equivalent to the main section in  
     141                                            file-level comments 
     142  `:Hidden:`        none         none       if present, indicate the routine  
     143                                            should not be shown in the  
     144                                            documentation 
     145  `:Hidden_file:`   none         none       if present, indicates the file  
     146                                            containing this routine should not  
     147                                            be shown in the documentation 
     148  `:History:`       comments     none       specifies the history of the  
     149                                            routine 
     150  `:Inherits:`      none         none       not used 
     151  `:Keywords:`      keyword name see below      documents keywords of the routine 
     152  `:Obsolete:`      none         none       if present, indicates the routine  
     153                                            is obsolete 
     154  `:Params:`        param name   see below  documents positional parameters of  
     155                                            the routine 
     156  `:Post:`          comments     none       specifies any post-conditions of  
     157                                            the routine 
     158  `:Pre:`           comments     none       specifies any pre-conditions of  
     159                                            the routine 
     160  `:Private:`       none         none       if present, indicates the routine  
     161                                            should not shown in user-level  
     162                                            documentation (set with the `USER`  
     163                                            keyword to IDLdoc) 
     164  `:Private_file:`  comments     none       if present, indicates the file  
     165                                            containing this routine should not  
     166                                            shown in user-level documentation  
     167                                            (set with the `USER` keyword to  
     168                                            IDLdoc) 
     169  `:Requires:`      comments     none       specifies the IDL version of the  
     170                                            routine; IDLdoc finds the routines  
     171                                            requiring the highest IDL version  
     172                                            and reports them on the warnings  
     173                                            page 
     174  `:Returns:`       comments     none       specifies the return value of the  
     175                                            function 
     176  `:Todo:`          comments     none       specifies any todo items left for  
     177                                            the routine 
     178  `:Uses:`          comments     none       specifies any other routines,  
     179                                            classes, etc. needed by the  
     180                                            routine 
     181  `:Version:`       comments     none       specifies the version of the  
     182                                            routine 
     183  ================= ============ ========== ================================= 
     184 
     185The `keyword` and `param` tags above accept attributes. The available attributes are shown below. 
     186 
     187.. table:: rst format style tag attributes 
     188 
     189  =============== ================= ========================================== 
     190  Attribute name  Syntax            Description 
     191  =============== ================= ========================================== 
     192  in              in                indicates the parameter is an input 
     193  out             out               indicates the parameter is an output 
     194  optional        optional          indicates argument is optional 
     195  private         private           indicates argument is not shown if IDLdoc  
     196                                    is run in user mode (`USER` keyword to  
     197                                    IDLdoc is set) 
     198  hidden          hidden            indicates the argument is not to be shown 
     199  required            required          indicates argument is required 
     200  type            type=comments     IDL data type of the argument 
     201  default         default=comments  default value of the argument 
     202  =============== ================= ========================================== 
     203 
     204 
     205TODO: overview files tags 
     206 
     207TODO: directory overview file tags 
    176208 
    177209 
    … …  
    181213The following tags are available in file comments (i.e. comment headers not immediately preceeding/following a routine header). 
    182214 
    183 =============== ============ ============ =================================== 
    184 Tag name        Arguments    Attributes   Description 
    185 =============== ============ ============ =================================== 
    186 `@author`       comments     none         specifies the author of the file 
    187 `@copyright`    comments     none         specifies the copyright information  
    188                                           for the file 
    189 `@examples`     comments     none         specifies examples of usage 
    190 `@hidden`       none         none         if present, indicates the file is  
    191                                           not to be shown in the documentation 
    192 `@history`      comments     none         lists the history for the file 
    193 `@private`      none         none         if present, indicates the file  
    194                                           should not shown in user-level  
    195                                           documentation (set with the `USER`  
    196                                           keyword to IDLdoc) 
    197 `@property`     property     none         describes a property of a class,  
    198                 name,                     i.e., a keyword to `getProperty`, 
    199                 comments                  `setProperty`, or `init` 
    200 `@version`      comments     none         specifies the version of the file 
    201 =============== ============ ============ =================================== 
    202  
    203 The following tags are available for comments immediately before or after a routine header. 
    204  
    205 ================ ============ =========== =================================== 
    206 Tag name         Arguments    Attributes  Description 
    207 ================ ============ =========== =================================== 
    208 `@abstract`      none         none        if present, indicates the method is  
    209                                           not implemented and present only to  
    210                                           specify the interface to subclasses'  
    211                                           implementations 
    212 `@author`        comments     none        specifies the author of the routine 
    213 `@bugs`          comments     none        specifies any issues found in the  
    214                                           routine 
    215 `@categories`    list         none        specifies a comma-separated list of  
    216                                           category names 
    217 `@copyright`     comments     none        specifies the copyright for the  
    218                                           routine 
    219 `@customer_id`   comments     none        specifies a customer ID for the  
    220                                           routine 
    221 `@description`   comments     none        a tag for the standard comments for  
    222                                           a routine; will be appended to  
    223                                           standard comments if both are  
    224                                           present 
    225 `@examples`      comments     none        specifies examples of using the  
    226                                           routine 
    227 `@field`         fieldname    none        specifies the name of the field  
    228                  and comments             followed by a description of the  
    229                                           field 
    230 `@file_comments` comments     none        equivalent to the main section in  
    231                                           file-level comments 
    232 `@hidden`        none         none        if present, indicate the routine  
    233                                           should not be shown in the  
    234                                           documentation 
    235 `@hidden_file`   none         none        if present, indicates the file  
    236                                           containing this routine should not  
    237                                           be shown in the documentation 
    238 `@history`       comments     none        specifies the history of the  
    239                                           routine 
    240 `@inherits`      none         none        not used 
    241 `@keyword`       keyword name see below   documents a keyword of the routine 
    242 `@obsolete`      none         none        if present, indicates the routine is  
    243                                           obsolete 
    244 `@param`         param name   see below   documents a positional parameter of  
    245                                           the routine 
    246 `@post`          comments     none        specifies any post-conditions of the  
    247                                           routine 
    248 `@pre`           comments     none        specifies any pre-conditions of the  
    249                                           routine 
    250 `@private`       none         none        if present, indicates the routine  
    251                                           should not shown in user-level  
    252                                           documentation (set with the `USER`  
    253                                           keyword to IDLdoc) 
    254 `@private_file`  comments     none        if present, indicates the file  
    255                                           containing this routine should not  
    256                                           shown in user-level documentation  
    257                                           (set with the `USER` keyword to  
    258                                           IDLdoc) 
    259 `@requires`      comments     none        specifies the IDL version of the  
    260                                           routine; IDLdoc finds the routines  
    261                                           requiring the highest IDL version  
    262                                           and reports them on the warnings  
    263                                           page 
    264 `@returns`       comments     none        specifies the return value of the  
    265                                           function 
    266 `@todo`          comments     none        specifies any todo items left for  
    267                                           the routine 
    268 `@uses`          comments     none        specifies any other routines,  
    269                                           classes, etc. needed by the routine 
    270 `@Version`       comments     none        specifies the version of the  
    271                                           routine 
    272 ================ ============ =========== =================================== 
    273  
    274  
    275 overview files tags 
    276  
    277 directory overview file tags 
     215.. table:: IDLdoc format style file tags 
     216 
     217  =============== ============ ============ ================================== 
     218  Tag name        Arguments    Attributes   Description 
     219  =============== ============ ============ ================================== 
     220  `@author`       comments     none         specifies the author of the file 
     221  `@copyright`    comments     none         specifies the copyright  
     222                                            information for the file 
     223  `@examples`     comments     none         specifies examples of usage 
     224  `@hidden`       none         none         if present, indicates the file is  
     225                                            not to be shown in the  
     226                                            documentation 
     227  `@history`      comments     none         lists the history for the file 
     228  `@private`      none         none         if present, indicates the file  
     229                                            should not shown in user-level  
     230                                            documentation (set with the `USER`  
     231                                            keyword to IDLdoc) 
     232  `@property`     property     none         describes a property of a class,  
     233                  name,                     i.e., a keyword to `getProperty`, 
     234                  comments                  `setProperty`, or `init` 
     235  `@version`      comments     none         specifies the version of the file 
     236  =============== ============ ============ ================================== 
     237 
     238The following tags are available for comments immediately preceding or following a routine header. 
     239 
     240.. table:: IDLdoc format style routine tags 
     241 
     242  ================ ============ =========== ================================== 
     243  Tag name         Arguments    Attributes  Description 
     244  ================ ============ =========== ================================== 
     245  `@abstract`      none         none        if present, indicates the method  
     246                                            is not implemented and present  
     247                                            only to specify the interface to  
     248                                            subclasses'  
     249                                            implementations 
     250  `@author`        comments     none        specifies the author of the  
     251                                            routine 
     252  `@bugs`          comments     none        specifies any issues found in the  
     253                                            routine 
     254  `@categories`    list         none        specifies a comma-separated list  
     255                                            of category names 
     256  `@copyright`     comments     none        specifies the copyright for the  
     257                                            routine 
     258  `@customer_id`   comments     none        specifies a customer ID for the  
     259                                            routine 
     260  `@description`   comments     none        a tag for the standard comments  
     261                                            for a routine; will be appended to  
     262                                            standard comments if both are  
     263                                            present 
     264  `@examples`      comments     none        specifies examples of using the  
     265                                            routine 
     266  `@field`         fieldname    none        specifies the name of the field  
     267                   and comments             followed by a description of the  
     268                                            field 
     269  `@file_comments` comments     none        equivalent to the main section in  
     270                                            file-level comments 
     271  `@hidden`        none         none        if present, indicate the routine  
     272                                            should not be shown in the  
     273                                            documentation 
     274  `@hidden_file`   none         none        if present, indicates the file  
     275                                            containing this routine should not  
     276                                            be shown in the documentation 
     277  `@history`       comments     none        specifies the history of the  
     278                                            routine 
     279  `@inherits`      none         none        not used 
     280  `@keyword`       keyword name see below   documents a keyword of the routine 
     281  `@obsolete`      none         none        if present, indicates the routine  
     282                                            is obsolete 
     283  `@param`         param name   see below   documents a positional parameter  
     284                                            of the routine 
     285  `@post`          comments     none        specifies any post-conditions of  
     286                                            the routine 
     287  `@pre`           comments     none        specifies any pre-conditions of  
     288                                            the routine 
     289  `@private`       none         none        if present, indicates the routine  
     290                                            should not shown in user-level  
     291                                            documentation (set with the `USER`  
     292                                            keyword to IDLdoc) 
     293  `@private_file`  comments     none        if present, indicates the file  
     294                                            containing this routine should not  
     295                                            shown in user-level documentation  
     296                                            (set with the `USER` keyword to  
     297                                            IDLdoc) 
     298  `@requires`      comments     none        specifies the IDL version of the  
     299                                            routine; IDLdoc finds the routines  
     300                                            requiring the highest IDL version  
     301                                            and reports them on the warnings  
     302                                            page 
     303  `@returns`       comments     none        specifies the return value of the  
     304                                            function 
     305  `@todo`          comments     none        specifies any todo items left for  
     306                                            the routine 
     307  `@uses`          comments     none        specifies any other routines,  
     308                                            classes, etc. needed by the  
     309                                            routine 
     310  `@Version`       comments     none        specifies the version of the  
     311                                            routine 
     312  ================ ============ =========== ================================== 
     313 
     314The keyword and param tags above accept attributes. The available attributes are shown below. 
     315 
     316.. table:: IDLdoc format style tag attributes 
     317 
     318  =============== ================= ========================================== 
     319  Attribute name  Syntax            Description 
     320  =============== ================= ========================================== 
     321  in              in                indicates the parameter is an input 
     322  out             out               indicates the parameter is an output 
     323  optional        optional          indicates argument is optional 
     324  private         private           indicates argument is not shown if IDLdoc  
     325                                    is run in user mode (`USER` keyword to  
     326                                    IDLdoc is set) 
     327  hidden          hidden            indicates the argument is not to be shown 
     328  required            required          indicates argument is required 
     329  type            type=comments     IDL data type of the argument 
     330  default         default=comments  default value of the argument 
     331  =============== ================= ========================================== 
     332 
     333TODO: overview files tags 
     334 
     335TODO: directory overview file tags 
    278336 
    279337 
    … …  
    281339~~~~~~~~~~~~~~~~ 
    282340 
    283 file tags 
    284  
    285 routine tags 
    286  
    287 overview files tags 
    288  
    289 directory overview file tags 
     341TODO: file tags 
     342 
     343TODO: routine tags 
     344 
     345TODO: overview files tags 
     346 
     347TODO: directory overview file tags 
    290348 
    291349 
    … …  
    293351------------- 
    294352 
     353TODO: what are markup styles? 
     354 
    295355 
    296356rst markup style 
    … …  
    314374------------------ 
    315375 
     376TODO: write this section 

  • trunk/reference/idldoc-tutorial.rst

    r689 r692  
    33 
    44:Author: Michael Galloy 
     5 
     6:Abstract: This tutorial attempts to provide a friendly guide to start using IDLdoc. See the reference guide for a more detailed listing of all the options that IDLdoc provides. 
    57 
    68