Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

idldoc_syntax.tt @ 191

Last change on this file since 191 was 69, checked in by smasson, 18 years ago
debug + new xxx
File size: 8.7 KB

Line
1	<div class="routine_details" id="_idldoc">
2
3	<h2><a class="top" href="#container">top</a>idldoc</h2>
4
5	<p class="header">
6	idldoc, <a href="#_idldoc_keyword_root">root</a>=<span class="result">string</span>[, <a href="#_idldoc_keyword_output">output</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_overview">overview</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_footer">footer</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_log_file">log_file</a>=<span class="result">string</span>][, /<a href="#_idldoc_keyword_user">user</a>][, /<a href="#_idldoc_keyword_quiet">quiet</a>][, /<a href="#_idldoc_keyword_silent">silent</a>][, /<a href="#_idldoc_keyword_embed">embed</a>][, /<a href="#_idldoc_keyword_nonavbar">nonavbar</a>][, <a href="#_idldoc_keyword_title">title</a>=<span class="result">string</span>][, <a href="#_idldoc_keyword_subtitle">subtitle</a>=<span class="result">string</span>][, /<a href="#_idldoc_keyword_statistics">statistics</a>][, <a href="#_idldoc_keyword_n_warnings">n_warnings</a>=<span class="result">variable</span>][, /<a href="#_idldoc_keyword_browse_routines">browse_routines</a>][, /<a href="#_idldoc_keyword_preformat">preformat</a>][, /<a href="#_idldoc_keyword_assistant">assistant</a>]</p>
7
8	<div class="comments">Calling routine for IDLdoc.</div>
9
10	<h3>Keywords</h3>
11
12	<h4 id="_idldoc_keyword_root">root
13	<span class="attr">in</span>
14	<span class="attr">required</span>
15	<span class="attr">type:</span> <span class="value">string</span>
16	</h4>
17
18	<div class="comments"> root directory for IDLdoc's
19	recursive search for .pro files. IDLdoc will find any
20	files with the '.pro' suffix and include them in its file
21	listings. Only directories with '.pro' files in them are
22	included in the directory listings.</div>
23
24	<h4 id="_idldoc_keyword_output">output
25	<span class="attr">in</span>
26	<span class="attr">optional</span>
27	<span class="attr">type:</span> <span class="value">string</span>
28	<span class="attr">default:</span> <span class="value">same as root</span>
29	</h4>
30
31	<div class="comments">
32	directory in which to create the HTML output and possible
33	subdirectories</div>
34
35	<h4 id="_idldoc_keyword_overview">overview
36	<span class="attr">in</span>
37	<span class="attr">optional</span>
38	<span class="attr">type:</span> <span class="value">string</span>
39	</h4>
40
41	<div class="comments"> filepath to a file containing the
42	summary of the package information about each directory in
43	the package.</div>
44
45	<h4 id="_idldoc_keyword_footer">footer
46	<span class="attr">in</span>
47	<span class="attr">optional</span>
48	<span class="attr">type:</span> <span class="value">string</span>
49	</h4>
50
51	<div class="comments"> filename for a footer to be placed
52	at the bottom of files; this file can contain any valid
53	HTML</div>
54
55	<h4 id="_idldoc_keyword_log_file">log_file
56	<span class="attr">in</span>
57	<span class="attr">optional</span>
58	<span class="attr">type:</span> <span class="value">string</span>
59	</h4>
60
61	<div class="comments"> set to a filename of a file to
62	contain the error messages generated by the IDLdoc run;
63	useful for automated runs of IDLdoc</div>
64
65	<h4 id="_idldoc_keyword_user">user
66	<span class="attr">in</span>
67	<span class="attr">optional</span>
68	<span class="attr">type:</span> <span class="value">boolean</span>
69	</h4>
70
71	<div class="comments"> set to create a listing appropriate
72	for <em>users</em> of the given library hierarchy; the
73	default is to create documentation suited to developers.
74	If set private routines are not shown in the
75	documentation.</div>
76
77	<h4 id="_idldoc_keyword_quiet">quiet
78	<span class="attr">in</span>
79	<span class="attr">optional</span>
80	<span class="attr">type:</span> <span class="value">boolean</span>
81	</h4>
82
83	<div class="comments"> if set, print only
84	warnings</div>
85
86	<h4 id="_idldoc_keyword_silent">silent
87	<span class="attr">in</span>
88	<span class="attr">optional</span>
89	<span class="attr">type:</span> <span class="value">boolean</span>
90	</h4>
91
92	<div class="comments"> if set, print no
93	messages</div>
94
95	<h4 id="_idldoc_keyword_embed">embed
96	<span class="attr">in</span>
97	<span class="attr">optional</span>
98	<span class="attr">type:</span> <span class="value">boolean</span>
99	</h4>
100
101	<div class="comments"> if set, embeds style sheet in each
102	HTML document; if this is not set, each HTML file will be
103	looking for the cascading style sheet idldoc.css in the
104	directory specified for the ROOT keyword</div>
105
106	<h4 id="_idldoc_keyword_nonavbar">nonavbar
107	<span class="attr">in</span>
108	<span class="attr">optional</span>
109	<span class="attr">type:</span> <span class="value">boolean</span>
110	</h4>
111
112	<div class="comments"> set to exclude the
113	navigation bar at the top of each page</div>
114
115	<h4 id="_idldoc_keyword_title">title
116	<span class="attr">in</span>
117	<span class="attr">optional</span>
118	<span class="attr">type:</span> <span class="value">string</span>
119	<span class="attr">default:</span> <span class="value">Research Systems</span>
120	</h4>
121
122	<div class="comments"> title of
123	the library</div>
124
125	<h4 id="_idldoc_keyword_subtitle">subtitle
126	<span class="attr">in</span>
127	<span class="attr">optional</span>
128	<span class="attr">type:</span> <span class="value">string</span>
129	<span class="attr">default:</span> <span class="value">IDL version</span>
130	</h4>
131
132	<div class="comments"> subtitle of
133	the library</div>
134
135	<h4 id="_idldoc_keyword_statistics">statistics
136	<span class="attr">in</span>
137	<span class="attr">optional</span>
138	<span class="attr">type:</span> <span class="value">boolean</span>
139	</h4>
140
141	<div class="comments"> set to calculate several
142	McCabe statistics for each routine</div>
143
144	<h4 id="_idldoc_keyword_n_warnings">n_warnings
145	<span class="attr">out</span>
146	<span class="attr">optional</span>
147	<span class="attr">type:</span> <span class="value">integer</span>
148	</h4>
149
150	<div class="comments"> set to a named variable to
151	contain the total number of warnings issued during the run</div>
152
153	<h4 id="_idldoc_keyword_browse_routines">browse_routines
154	<span class="attr">in</span>
155	<span class="attr">optional</span>
156	<span class="attr">type:</span> <span class="value">boolean</span>
157	</h4>
158
159	<div class="comments"> set to include a frame
160	to browse through the routines of the current file</div>
161
162	<h4 id="_idldoc_keyword_preformat">preformat
163	<span class="attr">in</span>
164	<span class="attr">optional</span>
165	<span class="attr">type:</span> <span class="value">boolean</span>
166	</h4>
167
168	<div class="comments"> set to produce output that
169	will look like it does in the code files (line for line)</div>
170
171	<h4 id="_idldoc_keyword_assistant">assistant
172	<span class="attr">in</span>
173	<span class="attr">optional</span>
174	<span class="attr">type:</span> <span class="value">boolean</span>
175	</h4>
176
177	<div class="comments"> set to produce output for the
178	IDL assistant help system instead of optimized for a web browser
179	</div>
180
181	<h3>Examples</h3><div class="value"> To run IDLdoc, try:
182	<center><code>idldoc, root='C:\mycode'</code></center>
183	where C:\mycode is the root of a directory tree containing IDL
184	.pro files.
185	</div>
186
187	<h3>Version history</h3>
188
189	<h4>Author</h4><div class="value"> Michael D. Galloy</div>
190
191	<h4>Copyright</h4><div class="value"> RSI, 2002</div>
192
193	<h3>Other attributes</h3>
194
195	<h4>Requires IDL version</h4><div class="value"> IDL 6.0</div>
196
197	</div>
198

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format