source: trunk/Documentation/idldoc/docs/idldoc-dev-help2.html @ 69

Last change on this file since 69 was 69, checked in by smasson, 18 years ago

debug + new xxx
File size: 22.4 KB
Line 
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 on Sat Mar 11 21:40:01 2006 -->
18
19<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
20  <head>
21    <title>IDLdoc Developer's Help (IDLdoc project documentation)</title>
22
23   
24    <style type="text/css" media="all">
25         
26/* CSS for all files which appear in the "main" viewing area: overview,
27   directory overviews, warnings, index, search, pro files, source
28   code, help, and etc files. */
29
30/* Link styles --------------------------------------------------------------- */
31
32a { text-decoration: none; }
33
34a:link, a:visited { 
35  color: #660000; 
36  border-bottom: 1px dotted #C0C0F0;   
37}
38
39a:hover, a:focus { 
40  color: #993333; 
41  background: #FFFFCC; 
42  border-bottom: 1px dotted #303099; 
43}
44
45
46/* Main styles --------------------------------------------------------------- */
47
48body {
49  margin: 0;
50  padding: 0;
51  font-size: 10pt;
52  font-family: Verdana, Helvetica, Arial, sans-serif;
53  background-color: #FFFFFF;
54}
55
56p {
57  margin-top: 0.5em;
58  margin-bottom: 0;
59}
60
61#container { margin: 1em; }
62
63code.section { white-space: pre; }
64
65pre.snippet {
66  margin-left: 5%;
67  background: #F0F0F0;
68  border: 1px dashed #999999;
69  width: 43em;
70  padding: 0.5em 0.5em 0.5em 0.5em;
71  white-space: pre;
72}
73
74/* Navbar styles ------------------------------------------------------------- */
75
76#navbar_title {
77  color: #000033;
78  background-color: #F0F0FF;
79  font-family: Arial, Helvetica, sans-serif;
80  padding: 20px 30px;
81  border-bottom: 1px solid #000033;
82}
83
84#navbar_title * {
85  margin: 0;
86  padding: 0;
87}
88
89#navbar_title h1 {
90  letter-spacing: 0.1em;
91  font-variant: small-caps;
92  font-size: 250%;
93  text-indent: -1em;
94  padding-left: 1em; 
95}
96
97#navbar_title h2 {
98  font-size: 110%;
99  font-weight: normal;
100  color: #333399;
101}
102
103#main_navbar table {
104  width: 100%;
105  border-bottom: 1px solid #666699;
106}
107
108#main_navbar td {
109  background: #CCCCFF;
110  font-size: 80%;
111  font-weight: bold;
112  font-family: Arial, Helvetica, sans-serif;
113  border-top: 3px solid #CCCCFF;
114  border-bottom: 3px solid #CCCCFF;
115  padding-left: 6px;
116  padding-right: 6px;
117  margin: 0;
118}
119
120#main_navbar td#selected {
121  background: #CCCCFF;
122  font-size: 80%;
123  font-weight: bold;
124  font-family: Arial, Helvetica, sans-serif;
125  border-top: 3px solid #333399;
126  border-bottom: 3px solid #CCCCFF;
127  padding-left: 6px;
128  padding-right: 6px;
129  margin: 0;
130}
131
132#main_navbar td#flexible {
133  width: 100%;
134  text-align: right;
135  padding-right: 1em;
136  background: #CCCCFF;
137  font-size: 70%;
138  font-weight: normal;
139  font-family: Arial, Helvetica, sans-serif;
140  text-transform: uppercase;
141  border-top: 3px solid #CCCCFF;
142  border-bottom: 3px solid #CCCCFF;
143}
144
145#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
146
147#main_navbar a:hover, #main_navbar a:focus {
148  color: #FFFF66;
149  background: #CCCCFF;
150  border-bottom: 1px none #606099; 
151  border: 0;
152}
153
154#secondary_navbar {
155  font-size: 80%;
156  font-weight: normal;
157  font-family: Arial, Helvetica, sans-serif;
158  margin-top: 4px;
159  margin-left: 20px;
160  white-space: nowrap;
161}
162
163
164/* Tagline and footer styles ------------------------------------------------- */
165
166div#tagline {
167  margin-top: 6px;
168  border-top: 1px dotted lightsteelblue;
169  padding-top: 6px;
170  font-size: 66%;
171  font-style: italic;
172}
173
174div#footer {
175  margin-top: 6px;
176  border-top: 1px dotted lightsteelblue;
177  padding-top: 6px;
178  font-size: 66%;
179  font-style: italic;
180}
181
182/* Basic data presenation styles -------------------------------------------- */
183
184.index_letter { 
185  font-size: 300%;
186  font-weight: bold;
187  color: #000066; 
188  margin: 0.5em 0 0 -0.1em;
189}
190
191h1, h2, h3, h4 {
192  font-weight: normal;
193  color: #3333CC;
194}
195
196h1 {
197  padding-top: 0.75em;
198  font-size: 160%;
199}
200
201h2 {
202  padding-top: 1em;
203  font-size: 120%;
204  }
205
206h3 {
207  padding-top: 0.75em;
208  margin-bottom: 0.25em;
209  font-size: 100%;
210}
211
212h4 {
213  padding: 0;
214  margin: 0.5em 0 0 0;
215  font-size: 80%;
216}
217
218table.basic {
219  empty-cells: show;
220  margin: 1.5em 1em 0 1em;
221  border: 1px dotted #CFCFFF;
222  font-size: 80%;
223}
224
225table.basic th {
226  background-color: #F0F0FF;
227  font-weight: bold;
228  text-align: left;
229  padding: 4px 1em 4px 4px;
230  border-bottom: 1px dotted #666699;
231}
232
233table.basic td {
234  vertical-align: top;
235  padding: 4px 1em 4px 4px;
236}
237
238dd {
239  margin-bottom: 0.25em;
240  font-size: 80%;
241}
242
243
244/* Warnings styles ----------------------------------------------------------- */
245
246
247#todo dl, #bugs dl { 
248  margin: 0 0 0 1.5em;
249  font-size: 80%;
250}
251
252#todo dd, #bugs dd { 
253  margin-left: 3em; 
254  font-size: 100%;
255}
256
257#undoc table, #obsolete table, #statistics table {
258  width: 80%;
259  margin-left: 2em;
260}
261
262#undoc td, #obsolete td, #statistics td { 
263  padding: 0 0 0 0;
264  font-size: 80%;
265  white-space: nowrap;
266}
267
268#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
269
270#undoc td.docstat, #statistics td.stat { 
271  width: 50%;
272  text-align: right;
273}
274
275#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
276
277#undoc td.notdoc, #statistics td.warning { color: #993333; }
278
279/* File + routine styles ----------------------------------------------------- */
280
281h1.directory { 
282  padding: 1em 0 0 0;
283  margin: 0;
284  font-size: 66%;
285}
286
287h1.directory a { border-bottom: 0; }
288
289h2.pro_file { 
290  padding: 0;
291  margin: 0;
292  font-size: 140%;
293}
294
295div#file_attr {
296  padding: 0 1em 0 1em;
297  margin: 1em;
298  background: #F6F6F6;
299  border: 1px dotted #999999;
300}
301
302div#file_attr dt {
303  font-size: 80%;
304  font-weight: bold;
305}
306
307div#file_attr dd {
308  font-size: 80%;
309}
310
311div#class_diagram { 
312  padding: 1em 0 1em 0; 
313  white-space: pre;
314  font-family: 'Courier New';
315}
316
317table#sav_attr { 
318  font-size: 90%; 
319  margin: 1em; 
320  padding: 1em 1em 1em 1em;
321  background: #F6F6F6;
322  border: 1px dotted #999999;
323}
324
325table#sav_attr th { text-align: left; }
326
327table#sav_attr td { vertical-align: top; padding-right: 2em; }
328
329table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
330
331p.sav_warning { margin-left: 4em; font-family: 80%; }
332
333table.variables { 
334  font-family: 'Courier New', monospace; 
335  font-size: 80%; 
336  text-indent: -2em; 
337  padding-left: 2em; 
338}
339
340table.variables td.image { width: 64px; }
341
342div#file_comments { 
343  margin: 2em;
344  font-size: 80%;
345}
346
347
348div.field_summary {
349  padding: 0 1em 0 1em;
350  margin: 1em;
351  background: #FFFFF0;
352  border: 1px dotted #C0C000;
353}
354
355div#routine_summary { 
356  padding: 0 1em 0 1em;
357  margin: 1em;
358  background: #F0F0FF;
359  border: 1px dotted #9999FF;
360}
361
362div.field_summary h2, div#routine_summary h2 { 
363  padding: 0.5em 0 0 0;
364  margin: 0;
365}
366
367div.field_summary table, div.field_summary p { 
368  margin: 1em 1em;
369}
370
371div.field_summary td.name { 
372  vertical-align: top;
373  padding-bottom: 0.25em;
374  color: #3333CC;
375}
376
377div.field_summary span.field_type { 
378  font-weight: normal;
379  font-size: 80%;
380  color: black;
381}
382
383div.field_summary td.comments { 
384  vertical-align: top;
385  padding-left: 2em;
386  font-size: 80%;
387}
388
389p.commaList { 
390  margin: 1em 1em 1em 1em;
391}
392
393span.warning { 
394  color: #CC6633;
395  font-weight: bold;
396  font-size: 66%;
397  text-transform: uppercase;
398}
399
400span.categories { 
401  color: #006633;
402  font-weight: bold;
403  font-size: 66%;
404  text-transform: uppercase;
405}
406
407span.undoc { 
408  color: #FF6633;
409  font-weight: bold;
410  font-size: 80%;
411  text-transform: uppercase;
412}
413
414span.attr { 
415  color: #006633;
416  font-weight: bold;
417  font-size: 80%;
418  text-transform: uppercase;
419}
420
421span.value { 
422  color: #006633;
423  font-weight: normal;
424  text-transform: none;
425}
426
427a.top { 
428  font-weight: bold;
429  font-size: 66%;
430  text-transform: uppercase;
431  float: right;
432}
433
434span.result { 
435  font-family: Verdana, Arial, Helvetica, sans-serif;
436  font-style: italic;
437  font-size: 80%;
438}
439
440div#routine_summary p, div.routine_details p.header { 
441  padding-top: 0.5em;
442  margin-left: 1.5em;
443  text-indent: -1.5em;
444  font-family: 'Courier New', monospace;
445}
446
447div.routine_details { 
448  padding: 0.5em 1em 0.5em 1em;
449  margin: 1em;
450  border: 1px dotted #CCCCCC;
451}
452
453div.routine_details h2 { 
454  padding-top: 0;
455  margin-top: 0;
456}
457
458div.routine_details div.value { 
459  margin: 0 1em 0 1em;
460  font-size: 80%;
461}
462
463div.routine_details div.comments { 
464  font-size: 80%;
465  margin: 0.75em 1em 1em 1em;
466}
467
468div.routine_details div.preformat { 
469  white-space: pre;
470}
471
472table.statistics { 
473  font-size: 80%;
474  margin-left: 1em;
475}
476
477table.statistics td { 
478  padding: 0 2em 0 0;
479}
480
481/* Overview styles ----------------------------------------------------------- */
482
483div.overview { 
484  width: 100%;
485  margin-top: 1em;
486  clear: both;
487}
488
489div.overview table {
490  empty-cells: show;
491  font-size: 90%;
492  margin: 1em 1em 1em 1em;
493  padding: 1em 0.5em 1em 0.5em;
494  background: #F6F6F6;
495  border: 1px dotted #999999;
496}
497
498div.overview td {
499  padding: 3px 1em 3px 1em;
500}
501
502div.overview td.dir {
503  width: 1%;
504  vertical-align: top;
505  text-align: right;
506  padding-right: 1em;
507}
508
509
510/* Navigation list styles for tree structures -------------------------------- */
511
512#tree {
513  text-align: left;
514  font-size: 90%;
515  margin: 0.75em 0 0.75em 0;
516  padding: 0;
517}
518
519#tree ul {
520  text-align: left;
521  margin: 0;
522  padding: 0;
523}
524
525#tree li {
526  margin: 0 0 0 15px;
527  padding: 0;
528  list-style-type: none;
529}
530
531#tree .symbols {
532  float: left;
533  width: 12px;
534  height: 1em;
535  padding-left: 4px;
536  background-position: 0 100%;
537  background-repeat: no-repeat;
538}
539
540/* Search styles ------------------------------------------------------------- */
541
542input.writein { 
543  padding-left: 0.5em;
544  border: 1px solid #CCCCCC;
545  font-family: 'Courier New';
546  background: #FFFFF3;
547}
548
549#search form { 
550  margin-left: 2em;
551}
552
553#search table { 
554  margin: 1em 1em 0 2em;
555  padding: 1em 2em 1em 2em;
556  background: #F6F6F6;
557  border: 1px dotted #999999;
558}
559
560#search tr { 
561  text-align: center;
562}
563
564#search td { 
565  font-size: 80%; 
566  text-align: left;
567}
568
569#search td * { 
570  vertical-align: middle;
571}
572
573#search p { 
574  font-size: 66%;
575  margin: 0 3em 2em 3em;
576}
577
578/* Help styles --------------------------------------------------------------- */
579
580div.toc { 
581  padding: 0 1em 0 1em;
582  margin: 1em;
583  background: #F0F0FF;
584  border: 1px dotted #9999FF; 
585  width: 19em;
586}
587
588div.right { 
589  float: right;
590  width: 22em;
591}
592
593ol.toc { 
594  list-style-type: upper-roman;
595}
596
597ol.toc ol { 
598  padding-left: 3em;
599  margin-left: 0;
600  list-style-type: lower-alpha;
601}
602
603dl.variables dt { font-size: 80%; }
604dl.variables dd { margin-bottom: 0.5em; }
605
606    </style>   
607    <style type="text/css" media="print">
608         #navbar_title { 
609  background-color: #FFFFFF; 
610}
611
612#main_navbar td {
613  background: #FFFFFF;
614  border-top: 0.25em solid #FFFFFF;
615  border-bottom: 0.25em solid #FFFFFF;
616}
617
618#main_navbar td#selected {
619  background: #FFFFFF;
620  border-top: 0.25em solid #333399;
621  border-bottom: 0.25em solid #FFFFFF;
622}
623
624#main_navbar td#flexible {
625  background: #FFFFFF;
626  border-top: 0.25em solid #FFFFFF;
627  border-bottom: 0.25em solid #FFFFFF;
628}
629
630#secondary_navbar {
631  display: none;
632}
633
634    </style>
635   
636
637    <script type="text/javascript">
638      function setTitle() {
639        parent.document.title="IDLdoc Developer's Help (IDLdoc project documentation)";
640      }
641    </script>
642  </head>
643
644
645  <body onload="setTitle();">
646
647    <div id="navbar_title">
648  <h1>IDLdoc project documentation</h1>
649  <h2>"The IDL code documentation project documentation"</h2>
650</div>
651
652
653
654    <div id="container">
655
656      <h1>Modifying IDLdoc's output</h1>
657
658      <p>This guide discusses how to modify the output from IDLdoc by
659      modifying the template files (*.tt) that are provided with
660      IDLdoc. Currently, only the templates directly documenting *.pro
661      files (pro-file.tt), templates included by pro-file.tt
662      (navbar.tt and tagline.tt) and objects implementing the template
663      interface used by pro-file.tt (IDLdocRoutine and IDLdocParam)
664      are documented for user customization. The plans is to release
665      the documentation for other templates as they become more stable
666      in future releases of IDLdoc.</p>
667
668      <p>In general, if one of the below variables is not
669      defined/not-appropriate it will be set to '' or -1.</p>
670
671      <h2>navbar.tt</h2>
672
673      <p>This template is included by many other templates requiring
674      those templates to provide the following variables:</p>
675
676      <dl class="variables">
677        <dt>title</dt>
678        <dd>title of the IDLdoc library</dd>
679
680        <dt>subtitle</dt>
681        <dd>subtitle of the IDLdoc library</dd>
682
683        <dt>categories_href</dt>
684        <dd>relative link to the categories page</dd>
685
686        <dt>categories_selected</dt>
687        <dd>boolean on whether the current page is the categories page</dd>
688
689        <dt>dir_overview_href</dt>
690        <dd>relative link to the directory overview page</dd>
691
692        <dt>dir_overview_selected</dt>
693        <dd>boolean on whether the current page is the directory overview page</dd>
694
695        <dt>etc_selected</dt>
696        <dd>boolean on whether the current page is an "Etc" page</dd>
697
698        <dt>file_selected</dt>
699        <dd>boolean on whether the current page is documentation of a PRO or SAV file</dd>
700
701        <dt>help_href</dt>
702        <dd>relative link to the help page</dd>
703
704        <dt>help_selected</dt>
705        <dd>boolean on whether the current page is the help page</dd>
706
707        <dt>index_href</dt>
708        <dd>relative link to the full index</dd>
709
710        <dt>index_selected</dt>
711        <dd>boolean on whether the current page is the full index page</dd>
712
713        <dt>overview_href</dt>
714        <dd>relative link to the library overview page</dd>
715
716        <dt>overview_selected</dt>
717        <dd>boolean on whether the current page is the library overview page</dd>
718
719        <dt>search_href</dt>
720        <dd>relative link to the search page</dd>
721
722        <dt>search_selected</dt>
723        <dd>boolean on whether the current page is the search page</dd>
724
725        <dt>source_href</dt>
726        <dd>relative link to the source code of a PRO file</dd>
727
728        <dt>source_selected</dt>
729        <dd>boolean on whether the current page is a source code page</dd>
730
731        <dt>user</dt>
732        <dd>boolean on whether the current documentation is generated for a user (as opposed to a developer)</dd>
733
734        <dt>prev_file_href</dt>
735        <dd>relative link to the previous PRO or SAV file page</dd>
736
737        <dt>next_file_href</dt>
738        <dd>relative link the next PRO or SAV file page</dd>
739
740        <dt>view_single_page_href</dt>
741        <dd>link to the current page</dd>
742
743        <dt>view_frames_href</dt>
744        <dd>link to the library index.html page</dd>
745
746        <dt>summary_fields_href</dt>
747        <dd>internal link to the fields summary; '' if no fields</dd>
748
749        <dt>summary_routine_href</dt>
750        <dd>internal link to the routine summary, '' if only one routine</dd>
751
752        <dt>details_routine_href</dt>
753        <dd>internal link to the start of the routine details</dd>
754      </dl>
755
756      <h2>tagline.tt</h2>
757
758      <p>This template is included by many other templates requiring
759      those templates to provide the following variables:</p>
760
761      <dl class="variables">
762        <dt>version</dt>
763        <dd>IDLdoc version as a string</dd>
764
765        <dt>date</dt>
766        <dd>string containing date of file creation</dd>
767      </dl>
768
769
770      <h2>pro-file.tt</h2>
771
772      <p>This file produces the output for the documentation of IDL
773      source code files. Variables provided to this template are all
774      those required by the navbar.tt and tagline.tt templates and
775      those listed below:</p>
776
777      <dl class="variables">
778        <dt>has_fields</dt>
779        <dd>base filename</dd>
780
781        <dt>is_class</dt>
782        <dd>boolean on whether this file corresponds to a class definition (and class variable is present)</dd>
783
784        <dt>class</dt>
785        <dd>IDLdocClass object</dd>
786
787        <dt>fields</dt>
788        <dd>base filename</dd>
789
790        <dt>pro_file</dt>
791        <dd>base filename</dd>
792
793        <dt>pro_dir</dt>
794        <dd>directory for file</dd>
795
796        <dt>root</dt>
797        <dd>relative path to the root of the library</dd>
798
799        <dt>last_modified</dt>
800        <dd>date last modified as a string</dd>
801
802        <dt>file_comments</dt>
803        <dd>file level comments</dd>
804
805        <dt>nroutines</dt>
806        <dd>number of IDLdocRoutine objects in routines array</dd>
807
808        <dt>routines</dt>
809        <dd>array of IDLdocRoutine objects; see below for variables in
810        these objects</dd>
811
812        <dt>nonavbar</dt>
813        <dd>set to 1 to indicate no navbar, otherwise set to 0</dd>
814
815        <dt>navbar_filename</dt>
816        <dd>filename of navbar template; appropriate for
817        INCLUDE_TEMPLATE directive</dd>
818
819        <dt>embed</dt>
820        <dd>0 for link to CSS, 1 for embed CSS</dd>
821
822        <dt>css_location</dt>
823        <dd>if embed then string filename of CSS file location, o/w
824        href to CSS file; for all media types</dd>
825
826        <dt>print_css_location</dt>
827        <dd>if embed then string filename of CSS file location, o/w
828        href to CSS file; for printing only</dd>
829
830        <dt>footer</dt>
831        <dd>filename of user-created footer to insert; appropriate for
832        the INCLUDE directive</dd>
833
834        <dt>separator</dt>
835        <dd>correct path separator, / or \ depending on Unix or
836        Windows system</dd>
837
838        <dt>tagline_filename</dt>
839        <dd>name of template for the bottom of the file; appropriate
840        for the INCLUDE_TEMPLATE directive</dd>
841      </dl>
842
843
844      <h3>IDLdocRoutine objects in pro-file.tt</h3>
845
846      <dl class="variables">
847        <dt>routine_name</dt>
848        <dd>string name of the routine</dd>
849
850        <dt>routine_url</dt>
851        <dd>internal url to the start of the routine details</dd>
852
853        <dt>is_func</dt>
854        <dd>boolean on whether the routine is a function</dd>
855
856        <dt>obsolete</dt>
857        <dd>boolean on whether the routine is marked obsolete</dd>
858
859        <dt>abstract</dt>
860        <dd>boolean on whether the routine is abstract (i.e. not implemented)</dd>
861
862        <dt>private</dt>
863        <dd>boolean on whether the routine is private (i.e. not visible in USER mode)</dd>
864
865        <dt>categories_present</dt>
866        <dd>boolean on whether the routine is marked with categories</dd>
867
868        <dt>categories</dt>
869        <dd>string array of list of categories as listed in the source</dd>
870
871        <dt>ntotalparams</dt>
872        <dd>total number of positional parameters and keywords</dd>
873
874        <dt>nparams</dt>
875        <dd>number of positional parameters</dd>
876
877        <dt>params</dt>
878        <dd>array of IDLdocParam objects</dd>
879
880        <dt>nkeywords</dt>
881        <dd>number of keywords</dd>
882
883        <dt>keywords</dt>
884        <dd>array of IDLdocParam objects</dd>
885
886        <dt>short_comment</dt>
887        <dd>first sentence of the routine comments</dd>
888
889        <dt>statistics</dt>
890        <dd>boolean on whether the McCabe complexity statistics have been calculated</dd>
891
892        <dt>mccabe_cyclic</dt>
893        <dd>McCabe Cyclic complexity (computed)</dd>
894
895        <dt>mccabe_essential</dt>
896        <dd>McCabe Essential complexity (computed)</dd>
897
898        <dt>mccabe_mod_design</dt>
899        <dd>McCabe Modular Design complexity (computed)</dd>
900
901        <dt>routine_comments</dt>
902        <dd>string array of comments for the routine</dd>
903
904        <dt>preformat</dt>
905        <dd>true if the comments are to be stripped from the source code and placed in the output with the same line breaks and formatting as the source code</dd>
906
907        <dt>returns_present</dt>
908        <dd>boolean on whether the returns tag is present</dd>
909
910        <dt>returns</dt>
911        <dd>documents the return value of a function</dd>
912
913        <dt>examples_present</dt>
914        <dd>boolean on whether the examples tag is present</dd>
915
916        <dt>examples</dt>
917        <dd>string array of example code using the routine</dd>
918
919        <dt>author_present</dt>
920        <dd>boolean on whether the author tag is present</dd>
921
922        <dt>author</dt>
923        <dd>author(s) of the routine</dd>
924
925        <dt>version_present</dt>
926        <dd>boolean on whether the version tag is present</dd>
927
928        <dt>version</dt>
929        <dd>version of the routine</dd>
930
931        <dt>history_present</dt>
932        <dd>boolean on whether the history tag is present</dd>
933
934        <dt>history</dt>
935        <dd>string array of history of the routine</dd>
936
937        <dt>copyright_present</dt>
938        <dd>boolean on whether the copyright tag is present</dd>
939
940        <dt>copyright</dt>
941        <dd>string array of copyright information about the routine</dd>
942
943        <dt>obsolete_comments_present</dt>
944        <dd>boolean on whether the obsolete tag is present</dd>
945
946        <dt>obsolete_comments</dt>
947        <dd>comments following the obsolete tag and further explaining the status of the routine (and alternatives)</dd>
948
949        <dt>bugs_present</dt>
950        <dd>boolean on whether the bugs tag is present</dd>
951
952        <dt>bugs</dt>
953        <dd>string array describing known issues with the routine</dd>
954
955        <dt>todo_present</dt>
956        <dd>boolean on whether the todo tag is present</dd>
957
958        <dt>todo</dt>
959        <dd>string array of items that still need to be done for the routine</dd>
960
961        <dt>restrictions_present</dt>
962        <dd>boolean on whether the restrictions tag is present</dd>
963
964        <dt>restrictions</dt>
965        <dd>restrictions on the use of the routine</dd>
966
967        <dt>inherits_present</dt>
968        <dd>boolean on whether the inherits tag is present</dd>
969
970        <dt>inherits</dt>
971        <dd>desribes other classes the class inherits from (this is not needed any longer)</dd>
972
973        <dt>requires_present</dt>
974        <dd>boolean on whether the requires tag is present</dd>
975
976        <dt>requires</dt>
977        <dd>which IDL verion is necessary to run this routine</dd>
978
979        <dt>uses_present</dt>
980        <dd>boolean on whether the uses tag is present</dd>
981
982        <dt>uses</dt>
983        <dd>which routines this routine calls</dd>
984
985        <dt>common_blocks_present</dt>
986        <dd>boolean on whether the common block information is present</dd>
987
988        <dt>common_blocks</dt>
989        <dd>names of common blocks used by routine</dd>
990
991        <dt>precondition_present</dt>
992        <dd>boolean on whether the routine is marked with a precondition tag</dd>
993
994        <dt>precondition</dt>
995        <dd>condition that should be satisfied before the routine is executed</dd>
996
997        <dt>postcondition_present</dt>
998        <dd>boolean on whether the routine is marked with a postcondition tag</dd>
999
1000        <dt>postcondition</dt>
1001        <dd>condition that should be satisfied after the routine is executed</dd>
1002
1003      </dl>
1004
1005
1006      <h3>IDLdocParam objects in pro-file.tt</h3>
1007
1008      <dl class="variables">
1009        <dt>name</dt>
1010        <dd>name of the parameter</dd>
1011
1012        <dt>in</dt>
1013        <dd>true if parameter is an input to the routine</dd>
1014
1015        <dt>out</dt>
1016        <dd>true if the parameter is an output to the routine</dd>
1017
1018        <dt>optional</dt>
1019        <dd>true if parameter is optional</dd>
1020
1021        <dt>required</dt>
1022        <dd>true if parameter is required</dd>
1023
1024        <dt>private</dt>
1025        <dd>hidden if parameter is supposed to be hidden from users of the routine, but visible to developers</dd>
1026
1027        <dt>hidden</dt>
1028        <dd>true if parameter is supposed to be hidden</dd>
1029
1030        <dt>type</dt>
1031        <dd>data type of the parameter</dd>
1032
1033        <dt>boolean</dt>
1034        <dd>true if the param is a switch</dd>
1035
1036        <dt>default</dt>
1037        <dd>default value of the parameter</dd>
1038
1039        <dt>comments</dt>
1040        <dd>string array of comments for parameter</dd>
1041
1042        <dt>delim</dt>
1043        <dd>appropriate delimiter preceeding parameter in a syntax listing of the routine (i.e. always a comma unless it's the first parameter of a function call)</dd>
1044      </dl>
1045
1046     
1047
1048      <div id="tagline">Produced by IDLdoc 2.0 on Sat Mar 11 21:40:01 2006.</div>
1049
1050    </div>
1051
1052  </body>
1053</html>
Note: See TracBrowser for help on using the repository browser.