javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 19:21:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add directive info to directive docs

Browse Source 
Directive doc objects have a directiveInfo property that has two
properties: doc.directiveInfo.type and doc.directiveInfo.properties.

type: 'Component' or 'Directive'

properties: array of objects in the format { name, values }, where name
is either 'selector', 'inputs', or 'outputs' and values is an array of
strings.

Ex: {
      type: 'Component',
      properties: [
        {
          name: 'selector',
          values: ['button', '[button]']
        },
        {
          name: 'inputs',
          values: ['icon', 'color']
        }
      ]
    }
This commit is contained in:
Tim Lancina
2015-10-09 20:32:17 -05:00
parent f8fdcb6333
commit 551d1998f3
4 changed files with 43 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/docs/templates/common.template.html vendored
View File

@ -118,10 +118,10 @@ docType: "<$ doc.docType $>"
defined in <$ githubViewLink(doc) $>
</p>
<@- if doc.decorators @>
<h2>Annotations</h2>
<@- for decorator in doc.decorators @>
<h3 class="annotation">@<$ decorator.name $><$ paramList(decorator.arguments) $></h3>
<@- if doc.directiveInfo @>
<h2><$ doc.directiveInfo.type $></h2>
<@- for prop in doc.directiveInfo.properties @>
<span><$ prop.name $>: <@ for v in prop.values @><$ v $><@ if not loop.last @>, <@ endif @><@ endfor @></span>
<@ endfor @>
<@ endif -@>

1
scripts/docs/typescript-package/index.js
View File

@ -14,6 +14,7 @@ module.exports = new Package('typescript-parsing', [basePackage])
.factory(require('./services/tsParser/getFileInfo'))
.factory(require('./services/tsParser/getExportDocType'))
.factory(require('./services/tsParser/getContent'))
.factory(require('./services/tsParser/getDirectiveInfo'))
.factory('EXPORT_DOC_TYPES', function() {
return [

6
scripts/docs/typescript-package/processors/readTypeScriptModules.js
View File

@ -4,7 +4,8 @@ var _ = require('lodash');
var ts = require('typescript');
module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo,
getExportDocType, getContent, log) {
getExportDocType, getContent,
getDirectiveInfo, log) {
return {
$runAfter: ['files-read'],
@ -180,7 +181,8 @@ module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo,
moduleDoc: moduleDoc,
content: getContent(exportSymbol),
fileInfo: getFileInfo(exportSymbol, basePath),
location: getLocation(exportSymbol)
location: getLocation(exportSymbol),
directiveInfo: getDirectiveInfo(exportSymbol)
};
if(exportSymbol.flags & ts.SymbolFlags.Function) {

34
scripts/docs/typescript-package/services/tsParser/getDirectiveInfo.js Normal file
View File

@ -0,0 +1,34 @@
module.exports = function getDirectiveInfo() {
return function (symbol) {
var directiveInfo;
if (symbol.valueDeclaration) {
var decorators = symbol.valueDeclaration.decorators;
decorators && decorators.forEach(function(decorator){
try {
var expr = decorator.expression;
var type = expr.expression.text.match(/Component|Directive/);
if (type) {
// type is either Component or Directive
// properties are selector, inputs and outputs
directiveInfo = { type: type[0], properties: [] };
//Directive only takes one argument
expr.arguments[0].properties.forEach(function(prop){
var name = prop.name.text;
if (name === "selector") {
directiveInfo.properties.push({name: name, values: prop.initializer.text.split(",")});
}
if (name === "inputs" || name === "outputs") {
var values = prop.initializer.elements.map(function(e){ return e.text });
directiveInfo.properties.push({name: name, values: values });
}
});
}
} catch(e){}
});
}
return directiveInfo;
};
};