-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathabout-project-roadmap.html
197 lines (163 loc) · 4.04 KB
/
about-project-roadmap.html
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="description" content="A high-level overview of the plans for future work on the JSDoc 3 application."><title>Use JSDoc: Project Roadmap</title>
<link rel="stylesheet" href="lib/prettify.css" />
<script src="lib/prettify.js"></script>
<script type="text/javascript">
/* Make HTML 5 elements stylable in IE */
document.createElement('header');
document.createElement('nav');
document.createElement('article');
document.createElement('footer');
document.createElement('hgroup');
</script>
<style>
body { font: .85em 'Helvetica Neue', Helvetica, Arial, sans-serif; }
body
{
padding: 0;
margin: 0;
}
a, a:visited, a:active { color: #605C89; }
dl
{
margin-left: 0;
padding-left: 0;
}
dt
{
margin-left: 16px;
padding-left: 4px;
margin-top: 8px;
}
dt a, dt a:visited {
color: #3E00B6;
}
dd
{
margin-left: 16px;
padding-left: 4px;
}
code { font: .85em Consolas, "Lucida Console", Monaco, monospace; }
/* Make HTML 5 elements display block-level for consistent styling */
header, nav, article, footer, address { display: block; }
header
{
background-color: #EBEBEB;
color: #006FBB;
margin: 0;
margin-bottom: 32px;
padding: 18px;
font-size: 2.4em;
font-weight: bold;
border-bottom: 1px #C6C6C6 solid;
}
header a, header a:visited {
color: #006FBB;
text-decoration: none;
}
h1 { color: #B93A38; }
article { margin: 18px; }
pre
{
display: block;
border: 1px solid #999;
margin: 12px;
padding: 8px;
}
.example dt { font-weight: bold; }
footer
{
margin: 16px;
margin-top: 32px;
font-style: italic;
font-size: .8em;
}
</style>
</head>
<body>
<header>
<a href="./index.html">@use JSDoc</a>
</header>
<nav>
</nav>
<article>
<h1>Project Roadmap</h1>
<h3>Project Roadmap</h3>
<p>
This is a high-level overview of the plans for future work on the JSDoc 3 application. To propose new goals or discuss existing goals please post to the <a href="http://groups.google.com/group/jsdoc">official JSDoc mailing list</a>.
</p>
<h3>Version 3.0</h3>
<ol>
<li>✓ Support doclets associated with multiple <code>var</code> declarations, separated by commas.
<pre>
<code>
/** for a */
var a,
/** for b */
b;
</code>
</pre>
</li>
<li>✓ Support multiple doclets associated with a single code symbol.
<pre>
<code>
/**
* Set the name.
* @param {string} newName
*//**
* Get the name.
* @returns {string}
*/
this.name = function(newName){
if (typeof newName === 'string') {
this._name = newName;
}
else {
return this._name;
}
}
</code>
</pre>
</li>
<li>✓ Support documenting CommonJS modules with exported symbols.
<pre>
<code>
/**
* @module foo/bar
*/
/**
* An exported function.
*/
exports.doit = function(){
}
</code>
</pre>
</li>
<li>Improve compatibility with <a href="http://code.google.com/closure/compiler/docs/js-for-compiler.html#tags">Google's Closure Compiler</a>.
</li>
<li>✓ Add @default tag. Support automatic @default for simple values types like strings, numbers, null, or named variables.
<pre>
<code>
/**
* Is documented as having a default value of 1.
* @type {number}
* @default
*/
var count = 1;
</code>
</pre>
</li>
<li>✓ Simplify the commandline arguments as much as possible.</li>
<li>✓ Replace the bespoke templating toolset with an open source third party tool.</li>
</ol>
</article>
<footer>
Copyright © 2011 Michael Mathews <micmath@gmail.com><br>
This site is <a href="https://github.com/micmath/micmath.github.com">open source</a> and licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
</footer>
<script>prettyPrint()</script>
</body>
</html>