source: trunk/SRC/Documentation/idldoc_html_output/idldoc-dev-help2.html @ 168

Last change on this file since 168 was 168, checked in by pinsard, 18 years ago

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