1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style>
.KEYW {color: #933;}
.COMM {color: #bbb; font-style: italic;}
.NUMB {color: #393;}
.STRN {color: #393;}
.REGX {color: #339;}
.line {border-right: 1px dotted #666; color: #666; font-style: normal;}
</style></head><body><pre><span class='line'> 1</span> <span class="COMM">/**
<span class='line'> 2</span> @overview
<span class='line'> 3</span> @date $Date: 2009-06-21 23:36:33 +0100 (Sun, 21 Jun 2009) $
<span class='line'> 4</span> @version $Revision: 801 $
<span class='line'> 5</span> @location $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/trunk/jsdoc-toolkit/app/lib/JSDOC.js $
<span class='line'> 6</span> @name JSDOC.js
<span class='line'> 7</span> */</span><span class="WHIT">
<span class='line'> 8</span>
<span class='line'> 9</span> </span><span class="COMM">/**
<span class='line'> 10</span> This is the main container for the JSDOC application.
<span class='line'> 11</span> @namespace
<span class='line'> 12</span> */</span><span class="WHIT">
<span class='line'> 13</span> </span><span class="NAME">JSDOC</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
<span class='line'> 14</span> </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 15</span>
<span class='line'> 16</span> </span><span class="COMM">/**
<span class='line'> 17</span> @requires Opt
<span class='line'> 18</span> */</span><span class="WHIT">
<span class='line'> 19</span> </span><span class="KEYW">if</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="KEYW">typeof</span><span class="WHIT"> </span><span class="NAME">arguments</span><span class="WHIT"> </span><span class="PUNC">==</span><span class="WHIT"> </span><span class="STRN">"undefined"</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="NAME">arguments</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="PUNC">[</span><span class="PUNC">]</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 20</span> </span><span class="NAME">JSDOC.opt</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Opt.get</span><span class="PUNC">(</span><span class="WHIT">
<span class='line'> 21</span> </span><span class="WHIT"> </span><span class="NAME">arguments</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 22</span> </span><span class="PUNC">{</span><span class="WHIT">
<span class='line'> 23</span> </span><span class="WHIT"> </span><span class="NAME">a</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"allfunctions"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 24</span> </span><span class="NAME">c</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"conf"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 25</span> </span><span class="WHIT"> </span><span class="NAME">d</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"directory"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 26</span> </span><span class="WHIT"> </span><span class="STRN">"D[]"</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"define"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 27</span> </span><span class="WHIT"> </span><span class="NAME">e</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"encoding"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 28</span> </span><span class="WHIT"> </span><span class="STRN">"E[]"</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"exclude"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 29</span> </span><span class="WHIT"> </span><span class="NAME">h</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"help"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 30</span> </span><span class="WHIT"> </span><span class="NAME">n</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"nocode"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 31</span> </span><span class="WHIT"> </span><span class="NAME">o</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"out"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 32</span> </span><span class="WHIT"> </span><span class="NAME">p</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"private"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 33</span> </span><span class="WHIT"> </span><span class="NAME">q</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"quiet"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 34</span> </span><span class="WHIT"> </span><span class="NAME">r</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"recurse"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 35</span> </span><span class="WHIT"> </span><span class="NAME">S</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"securemodules"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 36</span> </span><span class="WHIT"> </span><span class="NAME">s</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"suppress"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 37</span> </span><span class="WHIT"> </span><span class="NAME">t</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"template"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 38</span> </span><span class="WHIT"> </span><span class="NAME">T</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"testmode"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 39</span> </span><span class="WHIT"> </span><span class="NAME">u</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"unique"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 40</span> </span><span class="WHIT"> </span><span class="NAME">v</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"verbose"</span><span class="PUNC">,</span><span class="WHIT">
<span class='line'> 41</span> </span><span class="WHIT"> </span><span class="NAME">x</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="STRN">"ext"</span><span class="WHIT">
<span class='line'> 42</span> </span><span class="WHIT"> </span><span class="PUNC">}</span><span class="WHIT">
<span class='line'> 43</span> </span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 44</span>
<span class='line'> 45</span> </span><span class="COMM">/** The current version string of this application. */</span><span class="WHIT">
<span class='line'> 46</span> </span><span class="NAME">JSDOC.VERSION</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="STRN">"2.3.0"</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 47</span>
<span class='line'> 48</span> </span><span class="COMM">/** Print out usage information and quit. */</span><span class="WHIT">
<span class='line'> 49</span> </span><span class="NAME">JSDOC.usage</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
<span class='line'> 50</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">"USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ..."</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 51</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">""</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 52</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">"OPTIONS:"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 53</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -a or --allfunctions\n Include all functions, even undocumented ones.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 54</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -c or --conf\n Load a configuration file.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 55</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -d=<PATH> or --directory=<PATH>\n Output to this directory (defaults to \"out\").\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 56</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -D=\"myVar:My value\" or --define=\"myVar:My value\"\n Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 57</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -e=<ENCODING> or --encoding=<ENCODING>\n Use this encoding to read and write files.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 58</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -E=\"REGEX\" or --exclude=\"REGEX\"\n Multiple. Exclude files based on the supplied regex.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 59</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -h or --help\n Show this message and exit.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 60</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -n or --nocode\n Ignore all code, only document comments with @name tags.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 61</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -o=<PATH> or --out=<PATH>\n Print log messages to a file (defaults to stdout).\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 62</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -p or --private\n Include symbols tagged as private, underscored and inner symbols.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 63</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -q or --quiet\n Do not output any messages, not even warnings.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 64</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -r=<DEPTH> or --recurse=<DEPTH>\n Descend into src directories.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 65</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -s or --suppress\n Suppress source code output.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 66</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -S or --securemodules\n Use Secure Modules mode to parse source code.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 67</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -t=<PATH> or --template=<PATH>\n Required. Use this template to format the output.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 68</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -T or --test\n Run all unit tests and exit.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 69</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -u or --unique\n Force file names to be unique, but not based on symbol names.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 70</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -v or --verbose\n Provide verbose feedback about what is happening.\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 71</span> </span><span class="WHIT"> </span><span class="NAME">print</span><span class="PUNC">(</span><span class="STRN">" -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n Scan source files with the given extension/s (defaults to js).\n"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 72</span> </span><span class="WHIT">
<span class='line'> 73</span> </span><span class="NAME">quit</span><span class="PUNC">(</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 74</span> </span><span class="PUNC">}</span><span class="WHIT">
<span class='line'> 75</span>
<span class='line'> 76</span> </span><span class="COMM">/*t:
<span class='line'> 77</span> plan(4, "Testing JSDOC namespace.");
<span class='line'> 78</span>
<span class='line'> 79</span> is(
<span class='line'> 80</span> typeof JSDOC,
<span class='line'> 81</span> "object",
<span class='line'> 82</span> "JSDOC.usage is a function."
<span class='line'> 83</span> );
<span class='line'> 84</span>
<span class='line'> 85</span> is(
<span class='line'> 86</span> typeof JSDOC.VERSION,
<span class='line'> 87</span> "string",
<span class='line'> 88</span> "JSDOC.VERSION is a string."
<span class='line'> 89</span> );
<span class='line'> 90</span>
<span class='line'> 91</span> is(
<span class='line'> 92</span> typeof JSDOC.usage,
<span class='line'> 93</span> "function",
<span class='line'> 94</span> "JSDOC.usage is a function."
<span class='line'> 95</span> );
<span class='line'> 96</span>
<span class='line'> 97</span> is(
<span class='line'> 98</span> typeof JSDOC.opt,
<span class='line'> 99</span> "object",
<span class='line'>100</span> "JSDOC.opt is a object."
<span class='line'>101</span> );
<span class='line'>102</span> */</span><span class="WHIT">
<span class='line'>103</span>
<span class='line'>104</span> </span><span class="KEYW">if</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">this.IO</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="NAME">IO.includeDir</span><span class="PUNC">(</span><span class="STRN">"lib/JSDOC/"</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'>105</span> </span></pre></body></html>
|
