summaryrefslogtreecommitdiffstats
path: root/o3d/documentation
diff options
context:
space:
mode:
authorgman@google.com <gman@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-08-19 00:08:29 +0000
committergman@google.com <gman@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-08-19 00:08:29 +0000
commit390d94e6d41312cf24bf17593321d27ea32e1692 (patch)
treeee7b49b5d23bf765cb0e17e4b2fbd4acabc9d2a2 /o3d/documentation
parent8653167fd370f88b3bcc2be052a9aa26873dbe44 (diff)
downloadchromium_src-390d94e6d41312cf24bf17593321d27ea32e1692.zip
chromium_src-390d94e6d41312cf24bf17593321d27ea32e1692.tar.gz
chromium_src-390d94e6d41312cf24bf17593321d27ea32e1692.tar.bz2
A bunch more docs fixes
Review URL: http://codereview.chromium.org/171070 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@23679 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'o3d/documentation')
-rw-r--r--o3d/documentation/jsdoc-toolkit-templates/class.tmpl3
-rw-r--r--o3d/documentation/jsdoc-toolkit-templates/publish.js17
-rw-r--r--o3d/documentation/jsdoc-toolkit-templates/static/stylesheet.css3
3 files changed, 21 insertions, 2 deletions
diff --git a/o3d/documentation/jsdoc-toolkit-templates/class.tmpl b/o3d/documentation/jsdoc-toolkit-templates/class.tmpl
index 2ebc03a..8a3766c 100644
--- a/o3d/documentation/jsdoc-toolkit-templates/class.tmpl
+++ b/o3d/documentation/jsdoc-toolkit-templates/class.tmpl
@@ -285,6 +285,9 @@ thisClass = data;
<td>{+tempInherited+}</td>
</tr>
</if>
+ <if test="isDeprecated(member)">
+ <td colspan="6" class="deprecated">[[]**DEPRECATED**]</td>
+ </if>
</table>
</div>
diff --git a/o3d/documentation/jsdoc-toolkit-templates/publish.js b/o3d/documentation/jsdoc-toolkit-templates/publish.js
index 75937ba..cf1800c 100644
--- a/o3d/documentation/jsdoc-toolkit-templates/publish.js
+++ b/o3d/documentation/jsdoc-toolkit-templates/publish.js
@@ -200,7 +200,7 @@ function publishInternal(symbolSet) {
filteredClasses.push(symbol);
// Comment these lines in to see what data is available to the templates.
- //if (symbol.name == 'Client' || symbol.name == 'particles') {
+ //if (symbol.name == 'Canvas') {
// print('------[' + symbol.name + ']-----------------------------------');
// dumpObject(symbol, 5);
//}
@@ -542,6 +542,18 @@ function getParameters(symbol) {
}
/**
+ * Returns whether or not the symbol is deprecated. Apparently jsdoctoolkit is
+ * supposed to extract this info for us but it's not so we have to do it
+ * manually.
+ * @param {!Symbol} symbol The symbol to check.
+ * @return {boolean} True if the symbol is deprecated.
+ */
+function isDeprecated(symbol) {
+ var tags = symbol.comment.getTag('deprecated');
+ return tags.length > 0;
+}
+
+/**
* Converts [ to [[] for ezt files.
* Also converts '\n\n' to <br/></br>
* @param {string} str to sanitize.
@@ -795,8 +807,9 @@ function linkifySingleType(place, type) {
var period = type.lastIndexOf('.');
if (period >= 0 && type != '...') {
var subType = type.substring(0, period);
+ var member = type.substring(period + 1);
symbol = getSymbol(subType);
- if (symbol) {
+ if (symbol && symbol.hasMember(member)) {
var field = type.substring(period + 1);
link = '<a class="el" href="' + getLinkToSymbol(symbol) + '#' +
field + '">' + type + '</a>';
diff --git a/o3d/documentation/jsdoc-toolkit-templates/static/stylesheet.css b/o3d/documentation/jsdoc-toolkit-templates/static/stylesheet.css
index 3a4f825..5202687 100644
--- a/o3d/documentation/jsdoc-toolkit-templates/static/stylesheet.css
+++ b/o3d/documentation/jsdoc-toolkit-templates/static/stylesheet.css
@@ -118,6 +118,9 @@ TD.mdname1 {
font-weight: bold;
-moz-border-radius: 8px 8px 8px 8px;
}
+.memproto .deprecated {
+ color: red;
+}
.paramkey {
text-align: right;
}