|
1 |
| -## Overview |
2 |
| - |
3 |
| -`DevDoc` is written in Perl and allows to document q scripts using simple tags; produced |
4 |
| -documentation is in HTML format. |
5 |
| - |
6 |
| -## Installation |
7 |
| - |
8 |
| -In order to use `DevDocs`, following packages need to be installed: |
9 |
| - |
10 |
| -### `NaturalDocs` |
11 |
| - |
12 |
| -Complete package is available for download from (NaturalDocs website)[http://www.naturaldocs.org/download.html] (version |
13 |
| -1.52). |
14 |
| - |
15 |
| -Few small modifications are required: |
16 |
| -- in file `NaturalDocs.bat` please change one line from: |
17 |
| - |
18 |
| - ``` |
19 |
| - perl NaturalDocs %NaturalDocsParams% |
20 |
| - ``` |
21 |
| -
|
22 |
| - to: |
23 |
| -
|
24 |
| - ``` |
25 |
| - perl pathToNaturalDocs\NaturalDocs %NaturalDocsParams% |
26 |
| - ``` |
27 |
| -
|
28 |
| - For example, for NaturalDocs located in: `C:\NaturalDocs.1.52`, changed path should read: |
29 |
| -
|
30 |
| - ``` |
31 |
| - perl C:\NaturalDocs.1.52\NaturalDocs %NaturalDocsParams% |
32 |
| - ``` |
33 |
| -- in file: `NaturalDocs.1.52\Modules\NaturalDocs\Menu.pm` change following lines from: |
34 |
| -
|
35 |
| - ```perl |
36 |
| - use constant MAXFILESINGROUP => 6; |
37 |
| - use constant MINFILESINNEWGROUP => 3; |
38 |
| - ``` |
39 |
| -
|
40 |
| - to: |
41 |
| - |
42 |
| - ```perl |
43 |
| - use constant MAXFILESINGROUP => 1; |
44 |
| - use constant MINFILESINNEWGROUP => 1; |
45 |
| - ``` |
46 |
| - |
47 |
| - (as per: http://sourceforge.net/projects/naturaldocs/forums/forum/279267/topic/2496639) |
48 |
| - |
49 |
| -### Perl |
50 |
| -
|
51 |
| -Recommended Perl distribution (ActivePerl) can be downloaded from: http://www.activestate.com/activeperl/downloads. Once it’s installed, please ensure that following packages are installed: |
52 |
| -
|
53 |
| -- File-Next |
54 |
| -- File-Path |
55 |
| -- Log-Log4perl |
56 |
| -
|
57 |
| -by searching through Perl Package Manager. |
58 |
| -
|
59 |
| -### `DevDocs` |
60 |
| -
|
61 |
| -`DevDocs` configuration requires to update the path in the `devDoc.pl` file, which by default is set to: |
62 |
| -
|
63 |
| -```perl |
64 |
| -# root path to natural docs |
65 |
| -my $naturalDocsPath = "NaturalDocs"; |
66 |
| -``` |
67 |
| - |
68 |
| -For example, for `NaturalDocs` located in: `C:\NaturalDocs.1.52`, changed path should read: |
69 |
| - |
70 |
| -```perl |
71 |
| -# root path to natural docs |
72 |
| -my $naturalDocsPath = "C:/NaturalDocs-1.52" |
73 |
| -``` |
74 |
| - |
75 | 1 | ## Documenting your q code
|
76 | 2 |
|
77 | 3 | ### Available tags
|
@@ -285,62 +211,3 @@ Shows sample call related to function definition. Each tag will be shown in html
|
285 | 211 | .ns.doNothing{[a;b;c]
|
286 | 212 | };
|
287 | 213 | ```
|
288 |
| - |
289 |
| -## Running `DevDocs` |
290 |
| - |
291 |
| -### General command format |
292 |
| - |
293 |
| -General command to generate documentation looks as follows: |
294 |
| - |
295 |
| -``` |
296 |
| -perl devDoc.pl -in inputPath -out outputPath -a 1 -p 0 |
297 |
| -``` |
298 |
| - |
299 |
| -where: |
300 |
| - |
301 |
| -- `in` - input path to folder containing files for processing (mandatory parameter) |
302 |
| -- `out` - path to output folder storing temporary files used by `NaturalDocs` and output HTML files containing the actual documentation (mandatory parameter) |
303 |
| -- `a` - flag to indicate if tag `/A/` (authors) should be included (1) or omitted (0) (optional parameter) |
304 |
| -- `p` - flag to indicate if private variables and functions should be included (1) or omitted (0); it assumes that privates are denoted by `p` in the name, eg. `.namespace.p.varOrFuncName` (optional parameter, default is set to 0 therefore in most cases `p` parameter can be omitted) |
305 |
| - |
306 |
| -### Sample commands |
307 |
| - |
308 |
| -#### Documentation without privates |
309 |
| - |
310 |
| -``` |
311 |
| -> perl devDoc.pl -in c:\Projects\q\qsl\trunk -out c:\Projects\q\qsl\trunk\docs |
312 |
| -``` |
313 |
| - |
314 |
| -Alternatively, flag 0 can be used to achieve the same effect: |
315 |
| - |
316 |
| -``` |
317 |
| -> perl devDoc.pl -in c:\Projects\q\qsl\trunk -out c:\Projects\q\qsl\trunk\docs -p 0 |
318 |
| -``` |
319 |
| - |
320 |
| -Sample log information should include similar details: |
321 |
| - |
322 |
| -``` |
323 |
| -> perl devDoc.pl -in c:\Projects\q\qsl\trunk -out c:\Projects\q\qsl\trunk\docs |
324 |
| -2011/11/18 15:43:44 inPath = c:\Projects\q\qsl\trunk |
325 |
| -2011/11/18 15:43:44 outPath = c:\Projects\q\qsl\trunk\docs |
326 |
| -2011/11/18 15:43:44 handlePrivates = 0 |
327 |
| -2011/11/18 15:43:44 Found file: c:/Projects/q/qsl/trunk/sl.q |
328 |
| -2011/11/18 15:43:44 1 q files found |
329 |
| -2011/11/18 15:43:44 creating file from input: c:/Projects/q/qsl/trunk/sl.q |
330 |
| -2011/11/18 15:43:44 saving to: c:/Projects/q/qsl/trunk/docs |
331 |
| -2011/11/18 15:43:44 starting NaturalDocs |
332 |
| -Finding files and detecting changes... |
333 |
| -Parsing 4 files... |
334 |
| -Building 1 file... |
335 |
| -Building 4 indexes... |
336 |
| -Done. |
337 |
| -2011/11/18 15:43:45 NaturalDocs processing completed |
338 |
| -``` |
339 |
| - |
340 |
| -#### Documentation with privates and authors |
341 |
| - |
342 |
| -``` |
343 |
| -> perl devDoc.pl -in c:\Projects\q\qsl\trunk -out c:\Projects\q\qsl\trunk\docs -a 1 -p 1 |
344 |
| -``` |
345 |
| - |
346 |
| - |
0 commit comments