feat(docs): export type info for var and const exports

Closes #3700
angular · Aug 24, 2015 · 9262727 · 9262727
1 parent 3963e0a
commit 9262727
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/docs/angular.io-package/processors/addJadeDataDocsProcessor.js b/docs/angular.io-package/processors/addJadeDataDocsProcessor.js
@@ -51,7 +51,8 @@ module.exports = function addJadeDataDocsProcessor() {
           var modulePageInfo  = _.map(doc.exports, function(exportDoc) {
             return {
               name: exportDoc.name + '-' + exportDoc.docType,
-              title: exportDoc.name
+              title: exportDoc.name,
+              varType: exportDoc.symbolTypeName && titleCase(exportDoc.symbolTypeName)
             };
           });
 

diff --git a/docs/angular.io-package/templates/jade-data.template.html b/docs/angular.io-package/templates/jade-data.template.html
@@ -2,7 +2,8 @@
 {%- for item in doc.data %}
   "{$ item.name $}" : {
     "title" : "{$ item.title $}"{% if item.intro %},
-    "intro" : "{$ item.intro $}"{% endif %}
+    "intro" : "{$ item.intro $}"{% endif %}{% if item.varType %},
+    "varType" : "{$ item.varType $}"{% endif %}
   }{% if not loop.last %},{% endif %}
 {% endfor -%}
-}
+}
diff --git a/docs/typescript-package/processors/readTypeScriptModules.js b/docs/typescript-package/processors/readTypeScriptModules.js
@@ -188,6 +188,12 @@ module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo,
       location: getLocation(exportSymbol)
     };
 
+    if (exportDoc.docType === 'var' || exportDoc.docType === 'const') {
+      exportDoc.symbolTypeName = exportSymbol.valueDeclaration.type &&
+                                 exportSymbol.valueDeclaration.type.typeName &&
+                                 exportSymbol.valueDeclaration.type.typeName.text;
+    }
+
     if(exportSymbol.flags & ts.SymbolFlags.Function) {
       exportDoc.parameters = getParameters(typeChecker, exportSymbol);
     }