Add optional aliases block to generated entries.

jdalton · Mar 19, 2015 · f841217 · f841217
1 parent 47a25c6
commit f841217
Showing 1 changed file with 21 additions and 3 deletions.
diff --git a/lib/generator.js b/lib/generator.js
@@ -148,7 +148,8 @@ function generateDoc(source, options) {
       return;
     }
     var tocGroup,
-        member = entry.getMembers(0) || '';
+        member = entry.getMembers(0) || '',
+        separator = member ? getSeparator(entry) : '';
 
     // Add the entry to the TOC.
     if (byCategories) {
@@ -192,14 +193,31 @@ function generateDoc(source, options) {
         'hash':      entry.getHash(hashStyle),
         'href':      url + '#L' + entry.getLineNumber(),
         'member':    member,
-        'name':      entry.getName(),
-        'separator': member ? getSeparator(entry) : ''
+        'name':      name,
+        'separator': separator
       })
     );
 
     // Add the description.
     entryMarkdown.push('\n' + entry.getDesc() + '\n');
 
+    // Add optional aliases.
+    var aliases = entry.getAliases();
+    if (!_.isEmpty(aliases)) {
+      entryMarkdown.push('#### Aliases');
+      entryMarkdown.push(
+        '*' +
+        _.map(aliases, function(alias) {
+          return interpolate('${member}${separator}${name}', {
+            'member': member,
+            'name': alias.getName(),
+            'separator': separator
+          });
+        }).join(', ') +
+        '*'
+      );
+      entryMarkdown.push('');
+    }
     // Add optional function parameters.
     var params = entry.getParams();
     if (!_.isEmpty(params)) {