summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGraeme Yeates <yeatesgraeme@gmail.com>2016-07-25 00:04:02 -0400
committerGitHub <noreply@github.com>2016-07-25 00:04:02 -0400
commit5fceccef5c03b51039edd0cbc681ea49d9c496d3 (patch)
tree8b10333de64da222245c002a55d2aea861073a30
parent4039c4f7ad1963c13f3e4243bd746a466ff95f71 (diff)
parentdd8de02df179eb83c049bfcfe2d1dc6d0daf9168 (diff)
downloadasync-5fceccef5c03b51039edd0cbc681ea49d9c496d3.tar.gz
Merge pull request #1254 from hargasinski/master
added alias documentation, fixes #1251
-rw-r--r--support/jsdoc/theme/static/styles/jsdoc-default.css9
-rw-r--r--support/jsdoc/theme/tmpl/method.tmpl9
2 files changed, 16 insertions, 2 deletions
diff --git a/support/jsdoc/theme/static/styles/jsdoc-default.css b/support/jsdoc/theme/static/styles/jsdoc-default.css
index 9c76d28..76ade41 100644
--- a/support/jsdoc/theme/static/styles/jsdoc-default.css
+++ b/support/jsdoc/theme/static/styles/jsdoc-default.css
@@ -403,12 +403,21 @@ code {
line-height: 30px;
}
+.alias-details {
+ margin-top: -10px;
+ border-left: none;
+}
+
.details dt {
width: 120px;
float: left;
padding-left: 10px;
}
+.alias-details dt {
+ padding-left: 0px;
+}
+
.details dd {
margin-left: 70px
}
diff --git a/support/jsdoc/theme/tmpl/method.tmpl b/support/jsdoc/theme/tmpl/method.tmpl
index 2cc0d80..8e1f904 100644
--- a/support/jsdoc/theme/tmpl/method.tmpl
+++ b/support/jsdoc/theme/tmpl/method.tmpl
@@ -21,6 +21,13 @@ var self = this;
</div>
<?js } ?>
+<?js if (data.alias) {?>
+ <dl class="details alias-details">
+ <dt class="tag-alias">Alias:</dt>
+ <dd class="tag-alias"><ul class="dummy"><li><?js= data.alias ?></li></ul></dd>
+ </dl>
+<?js } ?>
+
<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
<h5>Extends:</h5>
<?js= self.partial('augments.tmpl', data) ?>
@@ -103,5 +110,3 @@ var self = this;
<?js= self.partial('exceptions.tmpl', r) ?>
<?js });
} } ?>
-
-