diff --git a/package.json b/package.json index 29cc0fb389..432dc2af6d 100644 --- a/package.json +++ b/package.json @@ -67,8 +67,8 @@ "core-js": "2.4.1", "cpr": "2.0.0", "del": "2.2.2", - "dgeni": "0.4.2", - "dgeni-packages": "0.16.0", + "dgeni": "^0.4.7", + "dgeni-packages": "^0.16.10", "event-stream": "3.3.4", "file-loader": "0.9.0", "fs-extra": "^2.0.0", diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index d129b907a0..99bc597a37 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -1,8 +1,8 @@ var Package = require('dgeni').Package; var jsdocPackage = require('dgeni-packages/jsdoc'); var nunjucksPackage = require('dgeni-packages/nunjucks'); -var typescriptPackage = require('./typescript-package'); -var linksPackage = require('./links-package'); +var typescriptPackage = require('dgeni-packages/typescript'); +var linksPackage = require('dgeni-packages/links'); var gitPackage = require('dgeni-packages/git'); var path = require('path'); var semver = require('semver'); @@ -19,8 +19,8 @@ module.exports = function(currentVersion, initialVersionBuild) { .processor(require('./processors/latest-version')) .processor(require('./processors/index-page')) -.processor(require('./processors/jekyll')) .processor(require('./processors/remove-private-members')) +.processor(require('./processors/jekyll')) .processor(require('./processors/hide-private-api')) .processor(require('./processors/collect-inputs-outputs')) .processor(require('./processors/parse-returns-object')) @@ -103,8 +103,10 @@ module.exports = function(currentVersion, initialVersionBuild) { docPath += doc.name + '/index.md'; var path = config.v2DocsDir + '/' + (versionData.current.folder || '') + '/api/' + docPath; - path = path.replace('/home/ubuntu/ionic/src', '') - return path; + path = path.replace('/home/ubuntu/ionic/src', '') + .replace(__dirname.replace('ionic/scripts/docs', ''),'') + .replace('/ionic/src',''); + return path; } }]; }) diff --git a/scripts/docs/processors/hide-private-api.js b/scripts/docs/processors/hide-private-api.js index 15e2b6eb27..b14eee016c 100644 --- a/scripts/docs/processors/hide-private-api.js +++ b/scripts/docs/processors/hide-private-api.js @@ -2,17 +2,18 @@ module.exports = function removePrivateApi() { return { name: 'remove-private-api', description: 'Prevent the private apis from being rendered', + $runAfter: ['paths-computed'], $runBefore: ['rendering-docs'], $process: function(docs) { var publicDocs = []; - docs.forEach(function(doc){ - if(!doc.private){ + docs.forEach(function(doc){ + if (!doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))){ publicDocs.push(doc); return doc } }) - docs = publicDocs; - return docs; + docs = publicDocs; + return docs; } } }; diff --git a/scripts/docs/processors/parse-returns-object.js b/scripts/docs/processors/parse-returns-object.js index 4660d76b9f..fa999a0bf6 100644 --- a/scripts/docs/processors/parse-returns-object.js +++ b/scripts/docs/processors/parse-returns-object.js @@ -1,4 +1,4 @@ -module.exports = function removePrivateApi() { +module.exports = function parseReturnsObject() { /* * This processor assumes the format: diff --git a/scripts/docs/processors/remove-private-members.js b/scripts/docs/processors/remove-private-members.js index 98ab63f504..f7fa1ab592 100644 --- a/scripts/docs/processors/remove-private-members.js +++ b/scripts/docs/processors/remove-private-members.js @@ -8,12 +8,12 @@ module.exports = function removePrivateMembers() { docs.forEach(function(doc) { if (doc.members) { doc.members = doc.members.filter(function(member) { - return !member.tags.tagsByName.get('private') && !member.tags.tagsByName.get('internal'); + return !member.tags.tagsByName.get('hidden') && !member.tags.tagsByName.get('internal'); }); } if (doc.statics) { doc.statics = doc.statics.filter(function(staticMethod) { - return !staticMethod.tags.tagsByName.get('private') && !staticMethod.tags.tagsByName.get('internal') + return !staticMethod.tags.tagsByName.get('hidden') && !staticMethod.tags.tagsByName.get('internal') }); } }); diff --git a/scripts/docs/tag-defs/tag-defs.js b/scripts/docs/tag-defs/tag-defs.js index eb11fa6c0a..4be6b99e67 100644 --- a/scripts/docs/tag-defs/tag-defs.js +++ b/scripts/docs/tag-defs/tag-defs.js @@ -2,5 +2,6 @@ module.exports = [ {'name': 'advanced'}, {'name': 'demo'}, {'name': 'usage'}, + {'name': 'hidden'}, {'name': 'internal'} ]; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 9afcfa8a7f..c2bd0ce95e 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -204,8 +204,8 @@ angular_controller: APIDemoCtrl <@ endif @> <$ doc.name | dashCase $> <@ else @> <$ doc.name $> -<@- if doc.directiveInfo @> -

<$ doc.directiveInfo.properties[0].values $>

+<@- if doc.decorators[0].argumentInfo[0].selector @> +

<$ doc.decorators[0].argumentInfo[0].selector $>

<@ endif -@> <@ endif @> @@ -225,7 +225,7 @@ Delegate: <$ doc.delegate $> - + Improve this doc diff --git a/scripts/docs/typescript-package/index.js b/scripts/docs/typescript-package/index.js deleted file mode 100755 index 876c080855..0000000000 --- a/scripts/docs/typescript-package/index.js +++ /dev/null @@ -1,74 +0,0 @@ -var basePackage = require('dgeni-packages/base'); -var Package = require('dgeni').Package; -var path = require('canonical-path'); - -// Define the dgeni package for generating the docs -module.exports = new Package('typescript-parsing', [basePackage]) - -// Register the services and file readers -.factory(require('./services/modules')) -.factory(require('./services/tsParser')) -.factory(require('./services/tsParser/createCompilerHost')) -.factory(require('./services/tsParser/getFileInfo')) -.factory(require('./services/tsParser/getExportDocType')) -.factory(require('./services/tsParser/getContent')) -.factory(require('./services/tsParser/getDirectiveInfo')) - -.factory(require('./services/convertPrivateClassesToInterfaces')) - -.factory('EXPORT_DOC_TYPES', function() { - return [ - 'class', - 'interface', - 'function', - 'var', - 'const', - 'let', - 'enum', - 'type-alias' - ]; -}) - - -// Register the processors -.processor(require('./processors/readTypeScriptModules')) - - -// Configure the log service -.config(function(log) { - log.level = 'warn'; -}) - - -// Configure ids and paths -.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) { - - computeIdsProcessor.idTemplates.push({ - docTypes: ['member'], - idTemplate: '${classDoc.id}.${name}', - getAliases: function(doc) { - return doc.classDoc.aliases.map(function(alias) { return alias + '.' + doc.name; }); - } - }); - - computePathsProcessor.pathTemplates.push({ - docTypes: ['member'], - pathTemplate: '${classDoc.path}#${name}', - getOutputPath: function() {} // These docs are not written to their own file, instead they are part of their class doc - }); - - var MODULES_DOCS_PATH = 'partials/modules'; - - computePathsProcessor.pathTemplates.push({ - docTypes: ['module'], - pathTemplate: '/${id}', - outputPathTemplate: MODULES_DOCS_PATH + '/${id}/index.html' - }); - - computePathsProcessor.pathTemplates.push({ - docTypes: EXPORT_DOC_TYPES, - pathTemplate: '${moduleDoc.path}/${name}', - outputPathTemplate: MODULES_DOCS_PATH + '/${path}/index.html' - }); - -}); diff --git a/scripts/docs/typescript-package/mocks/mockPackage.js b/scripts/docs/typescript-package/mocks/mockPackage.js deleted file mode 100755 index 834d53c959..0000000000 --- a/scripts/docs/typescript-package/mocks/mockPackage.js +++ /dev/null @@ -1,11 +0,0 @@ -var Package = require('dgeni').Package; - -module.exports = function mockPackage() { - - return new Package('mockPackage', [require('../')]) - - // provide a mock log service - .factory('log', function() { return require('dgeni/lib/mocks/log')(false); }) - .factory('templateEngine', function() { return {}; }); - -}; diff --git a/scripts/docs/typescript-package/mocks/readTypeScriptModules/ignoreExportsMatching.ts b/scripts/docs/typescript-package/mocks/readTypeScriptModules/ignoreExportsMatching.ts deleted file mode 100755 index 476d4cc44b..0000000000 --- a/scripts/docs/typescript-package/mocks/readTypeScriptModules/ignoreExportsMatching.ts +++ /dev/null @@ -1,4 +0,0 @@ -export var __esModule = true; -export class OKToExport {} -export function _thisIsPrivate() {} -export var thisIsOK = '!'; \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/readTypeScriptModules/interfaces.ts b/scripts/docs/typescript-package/mocks/readTypeScriptModules/interfaces.ts deleted file mode 100755 index a2d4be4fec..0000000000 --- a/scripts/docs/typescript-package/mocks/readTypeScriptModules/interfaces.ts +++ /dev/null @@ -1,5 +0,0 @@ -export interface MyInterface { - optionalProperty? : string - >(param: T) : U - new (param: number) : MyInterface -} \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/readTypeScriptModules/orderingOfMembers.ts b/scripts/docs/typescript-package/mocks/readTypeScriptModules/orderingOfMembers.ts deleted file mode 100755 index 2020ec7fa4..0000000000 --- a/scripts/docs/typescript-package/mocks/readTypeScriptModules/orderingOfMembers.ts +++ /dev/null @@ -1,6 +0,0 @@ -export class Test { - firstItem; - constructor() { this.doStuff(); } - otherMethod() {} - doStuff() {} -} \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/readTypeScriptModules/privateModule.ts b/scripts/docs/typescript-package/mocks/readTypeScriptModules/privateModule.ts deleted file mode 100755 index d4c6ef610a..0000000000 --- a/scripts/docs/typescript-package/mocks/readTypeScriptModules/privateModule.ts +++ /dev/null @@ -1 +0,0 @@ -export var x = 10; \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/readTypeScriptModules/publicModule.ts b/scripts/docs/typescript-package/mocks/readTypeScriptModules/publicModule.ts deleted file mode 100755 index bbb7cc82c3..0000000000 --- a/scripts/docs/typescript-package/mocks/readTypeScriptModules/publicModule.ts +++ /dev/null @@ -1,3 +0,0 @@ -export { x as y } from './privateModule'; - -export abstract class AbstractClass {} \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/tsParser/importedSrc.ts b/scripts/docs/typescript-package/mocks/tsParser/importedSrc.ts deleted file mode 100755 index 74a115e5fe..0000000000 --- a/scripts/docs/typescript-package/mocks/tsParser/importedSrc.ts +++ /dev/null @@ -1 +0,0 @@ -export var x = 100; \ No newline at end of file diff --git a/scripts/docs/typescript-package/mocks/tsParser/testSrc.ts b/scripts/docs/typescript-package/mocks/tsParser/testSrc.ts deleted file mode 100755 index 7b6d3f18dd..0000000000 --- a/scripts/docs/typescript-package/mocks/tsParser/testSrc.ts +++ /dev/null @@ -1,34 +0,0 @@ -/** - * @module - * @description - * This is the module description - */ - -export * from 'importedSrc'; - -/** - * This is some random other comment - */ - -/** - * This is MyClass - */ -export class MyClass { - message: String; - - /** - * Create a new MyClass - * @param {String} name The name to say hello to - */ - constructor(name) { this.message = 'hello ' + name; } - - /** - * Return a greeting message - */ - greet() { return this.message; } -} - -/** - * An exported function - */ -export var myFn = (val: number) => return val * 2; \ No newline at end of file diff --git a/scripts/docs/typescript-package/processors/readTypeScriptModules.js b/scripts/docs/typescript-package/processors/readTypeScriptModules.js deleted file mode 100755 index 8d10ce2158..0000000000 --- a/scripts/docs/typescript-package/processors/readTypeScriptModules.js +++ /dev/null @@ -1,461 +0,0 @@ -var glob = require('glob'); -var path = require('canonical-path'); -var _ = require('lodash'); -var ts = require('typescript'); - -module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo, - getDirectiveInfo, - getExportDocType, getContent, - createDocMessage, log) { - - return { - $runAfter: ['files-read'], - $runBefore: ['parsing-tags'], - - $validate: { - sourceFiles: {presence: true}, - basePath: {presence: true}, - hidePrivateMembers: {inclusion: [true, false]}, - sortClassMembers: {inclusion: [true, false]}, - ignoreExportsMatching: {} - }, - - // A collection of globs that identify those modules for which we should create docs - sourceFiles: [], - // The base path from which to load the source files - basePath: '.', - // We can ignore members of classes that are private - hidePrivateMembers: true, - // We leave class members sorted in order of declaration - sortClassMembers: false, - // We can provide a collection of strings or regexes to ignore exports whose export names match - ignoreExportsMatching: ['___esModule'], - - $process: function(docs) { - - // Convert ignoreExportsMatching to an array of regexes - var ignoreExportsMatching = convertToRegexCollection(this.ignoreExportsMatching); - - var hidePrivateMembers = this.hidePrivateMembers; - var sortClassMembers = this.sortClassMembers; - - var basePath = path.resolve(this.basePath); - var filesPaths = expandSourceFiles(this.sourceFiles, basePath); - var parseInfo = tsParser.parse(filesPaths, this.basePath); - var moduleSymbols = parseInfo.moduleSymbols; - - // Iterate through each of the modules that were parsed and generate a module doc - // as well as docs for each module's exports. - moduleSymbols.forEach(function(moduleSymbol) { - - var moduleDoc = createModuleDoc(moduleSymbol, basePath); - - // Add this module doc to the module lookup collection and the docs collection - modules[moduleDoc.id] = moduleDoc; - docs.push(moduleDoc); - - // Iterate through this module's exports and generate a doc for each - moduleSymbol.exportArray.forEach(function(exportSymbol) { - - // Ignore exports starting with an underscore - if (anyMatches(ignoreExportsMatching, exportSymbol.name)) return; - - // If the symbol is an Alias then for most things we want the original resolved symbol - var resolvedExport = exportSymbol.resolvedSymbol || exportSymbol; - - // If the resolved symbol contains no declarations then it is invalid - // (probably an abstract class) - // For the moment we are just going to ignore such exports - // TODO: find a way of generating docs for them - if (!resolvedExport.declarations) return; - - var exportDoc = createExportDoc(exportSymbol.name, resolvedExport, moduleDoc, basePath, parseInfo.typeChecker); - - // Ignore exports marked as "@private" in jsDoc content - var jsDocContainsPrivate = (exportDoc.content || '').split('\n').some(function(commentRow) { - return commentRow.search(/@private|@access private/) >= 0; - }); - if (jsDocContainsPrivate) return; - - log.debug('>>>> EXPORT: ' + exportDoc.name + ' (' + exportDoc.docType + ') from ' + moduleDoc.id); - - // Add this export doc to its module doc - moduleDoc.exports.push(exportDoc); - docs.push(exportDoc); - - exportDoc.members = []; - exportDoc.statics = []; - - // Generate docs for each of the export's members - if (resolvedExport.flags & ts.SymbolFlags.HasMembers) { - - for(var memberName in resolvedExport.members) { - // FIXME(alexeagle): why do generic type params appear in members? - if (memberName === 'T') { - continue; - } - log.silly('>>>>>> member: ' + memberName + ' from ' + exportDoc.id + ' in ' + moduleDoc.id); - var memberSymbol = resolvedExport.members[memberName]; - var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker); - - // We special case the constructor and sort the other members alphabetically - if (memberSymbol.flags & ts.SymbolFlags.Constructor) { - exportDoc.constructorDoc = memberDoc; - docs.push(memberDoc); - } else if (!hidePrivateMembers || memberSymbol.name.charAt(0) !== '_') { - docs.push(memberDoc); - exportDoc.members.push(memberDoc); - } else if (memberSymbol.name === '__call' && memberSymbol.flags & ts.SymbolFlags.Signature) { - docs.push(memberDoc); - exportDoc.callMember = memberDoc; - } else if (memberSymbol.name === '__new' && memberSymbol.flags & ts.SymbolFlags.Signature) { - docs.push(memberDoc); - exportDoc.newMember = memberDoc; - } - } - } - - if (exportDoc.docType === 'enum') { - for(var memberName in resolvedExport.exports) { - log.silly('>>>>>> member: ' + memberName + ' from ' + exportDoc.id + ' in ' + moduleDoc.id); - var memberSymbol = resolvedExport.exports[memberName]; - var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker); - docs.push(memberDoc); - exportDoc.members.push(memberDoc); - } - } else if (resolvedExport.flags & ts.SymbolFlags.HasExports) { - for (var exported in resolvedExport.exports) { - if (exported === 'prototype') continue; - if (hidePrivateMembers && exported.charAt(0) === '_') continue; - var memberSymbol = resolvedExport.exports[exported]; - var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker); - memberDoc.isStatic = true; - docs.push(memberDoc); - exportDoc.statics.push(memberDoc); - } - } - - if (sortClassMembers) { - exportDoc.members.sort(function(a, b) { - if (a.name > b.name) return 1; - if (a.name < b.name) return -1; - return 0; - }); - exportDoc.statics.sort(function(a, b) { - if (a.name > b.name) return 1; - if (a.name < b.name) return -1; - return 0; - }); - } - }); - }); - } - }; - - - function createModuleDoc(moduleSymbol, basePath) { - var id = moduleSymbol.name.replace(/^"|"$/g, ''); - var name = id.split('/').pop(); - var moduleDoc = { - docType: 'module', - name: name, - id: id, - aliases: [id, name], - moduleTree: moduleSymbol, - content: getContent(moduleSymbol), - exports: [], - fileInfo: getFileInfo(moduleSymbol, basePath), - location: getLocation(moduleSymbol) - }; - return moduleDoc; - } - - function createExportDoc(name, exportSymbol, moduleDoc, basePath, typeChecker) { - var typeParamString = ''; - var heritageString = ''; - var typeDefinition = ''; - - exportSymbol.declarations.forEach(function(decl) { - var sourceFile = ts.getSourceFileOfNode(decl); - - if (decl.typeParameters) { - typeParamString = '<' + getText(sourceFile, decl.typeParameters) + '>'; - } - - if (decl.symbol.flags & ts.SymbolFlags.TypeAlias) { - typeDefinition = getText(sourceFile, decl.type); - } - - if (decl.heritageClauses) { - decl.heritageClauses.forEach(function(heritage) { - - if (heritage.token == ts.SyntaxKind.ExtendsKeyword) { - heritageString += " extends"; - heritage.types.forEach(function(typ, idx) { - heritageString += (idx > 0 ? ',' : '') + typ.getFullText(); - }); - } - - if (heritage.token == ts.SyntaxKind.ImplementsKeyword) { - heritageString += " implements"; - heritage.types.forEach(function(typ, idx) { - heritageString += (idx > 0 ? ', ' : '') + typ.getFullText(); - }); - } - }); - } - }); - - //Make sure duplicate aliases aren't created, so "Ambiguous link" warnings are prevented - var aliasNames = [name, moduleDoc.id + '/' + name]; - if (typeParamString) { - aliasNames.push(name + typeParamString); - aliasNames.push(moduleDoc.id + '/' + name + typeParamString); - } - - var exportDoc = { - docType: getExportDocType(exportSymbol), - exportSymbol: exportSymbol, - name: name, - id: moduleDoc.id + '/' + name, - typeParams: typeParamString, - heritage: heritageString, - decorators: getDecorators(exportSymbol), - aliases: aliasNames, - moduleDoc: moduleDoc, - content: getContent(exportSymbol), - fileInfo: getFileInfo(exportSymbol, basePath), - location: getLocation(exportSymbol), - directiveInfo: getDirectiveInfo(exportSymbol) - }; - - if (exportDoc.docType === 'var' || exportDoc.docType === 'const' || exportDoc.docType === 'let') { - exportDoc.symbolTypeName = exportSymbol.valueDeclaration.type && - exportSymbol.valueDeclaration.type.typeName && - exportSymbol.valueDeclaration.type.typeName.text; - } - - if (exportDoc.docType === 'type-alias') { - exportDoc.returnType = getReturnType(typeChecker, exportSymbol); - } - - if(exportSymbol.flags & ts.SymbolFlags.Function) { - exportDoc.parameters = getParameters(typeChecker, exportSymbol); - } - if(exportSymbol.flags & ts.SymbolFlags.Value) { - exportDoc.returnType = getReturnType(typeChecker, exportSymbol); - } - if (exportSymbol.flags & ts.SymbolFlags.TypeAlias) { - exportDoc.typeDefinition = typeDefinition; - } - - // Compute the original module name from the relative file path - exportDoc.originalModule = exportDoc.fileInfo.relativePath - .replace(new RegExp('\.' + exportDoc.fileInfo.extension + '$'), ''); - - return exportDoc; - } - - function createMemberDoc(memberSymbol, classDoc, basePath, typeChecker) { - var memberDoc = { - docType: 'member', - classDoc: classDoc, - name: memberSymbol.name, - decorators: getDecorators(memberSymbol), - content: getContent(memberSymbol), - fileInfo: getFileInfo(memberSymbol, basePath), - location: getLocation(memberSymbol) - }; - - memberDoc.typeParameters = getTypeParameters(typeChecker, memberSymbol); - - if(memberSymbol.flags & (ts.SymbolFlags.Signature) ) { - memberDoc.parameters = getParameters(typeChecker, memberSymbol); - memberDoc.returnType = getReturnType(typeChecker, memberSymbol); - switch(memberDoc.name) { - case '__call': - memberDoc.name = ''; - break; - case '__new': - memberDoc.name = 'new'; - break; - } - } - - if (memberSymbol.flags & ts.SymbolFlags.Method) { - // NOTE: we use the property name `parameters` here so we don't conflict - // with the `params` property that will be updated by dgeni reading the - // `@param` tags from the docs - memberDoc.parameters = getParameters(typeChecker, memberSymbol); - } - - if (memberSymbol.flags & ts.SymbolFlags.Constructor) { - memberDoc.parameters = getParameters(typeChecker, memberSymbol); - memberDoc.name = 'constructor'; - } - - if(memberSymbol.flags & ts.SymbolFlags.Value) { - memberDoc.returnType = getReturnType(typeChecker, memberSymbol); - } - - if(memberSymbol.flags & ts.SymbolFlags.Optional) { - memberDoc.optional = true; - } - - return memberDoc; - } - - - function getDecorators(symbol) { - - var declaration = symbol.valueDeclaration || symbol.declarations[0]; - var sourceFile = ts.getSourceFileOfNode(declaration); - - var decorators = declaration.decorators && declaration.decorators.map(function(decorator) { - decorator = decorator.expression; - return { - name: decorator.expression ? decorator.expression.text : decorator.text, - arguments: decorator.arguments && decorator.arguments.map(function(argument) { - return getText(sourceFile, argument).trim(); - }), - argumentInfo: decorator.arguments && decorator.arguments.map(function(argument) { - return parseArgument(argument); - }), - expression: decorator - }; - }); - return decorators; - } - - function parseProperties(properties) { - var result = {}; - _.forEach(properties, function(property) { - result[property.name.text] = parseArgument(property.initializer); - }); - return result; - } - - function parseArgument(argument) { - if (argument.text) return argument.text; - if (argument.properties) return parseProperties(argument.properties); - if (argument.elements) return argument.elements.map(function(element) { return element.text; }); - var sourceFile = ts.getSourceFileOfNode(argument); - var text = getText(sourceFile, argument).trim(); - return text; - } - - function getParameters(typeChecker, symbol) { - var declaration = symbol.valueDeclaration || symbol.declarations[0]; - var sourceFile = ts.getSourceFileOfNode(declaration); - if (!declaration.parameters) { - var location = getLocation(symbol); - throw new Error('missing declaration parameters for "' + symbol.name + - '" in ' + sourceFile.fileName + - ' at line ' + location.start.line); - } - return declaration.parameters.map(function(parameter) { - var paramText = ''; - if (parameter.dotDotDotToken) { - paramText += '...'; - } - paramText += getText(sourceFile, parameter.name); - if (parameter.questionToken || parameter.initializer) { - paramText += '?'; - } - if (parameter.type) { - paramText += ':' + getType(sourceFile, parameter.type); - } else { - paramText += ': any'; - if (parameter.dotDotDotToken) { - paramText += '[]'; - } - } - return paramText.trim(); - }); - } - - function getTypeParameters(typeChecker, symbol) { - var declaration = symbol.valueDeclaration || symbol.declarations[0]; - var sourceFile = ts.getSourceFileOfNode(declaration); - if (!declaration.typeParameters) return; - var typeParams = declaration.typeParameters.map(function(type) { - return getText(sourceFile, type).trim(); - }); - return typeParams; - } - - function getReturnType(typeChecker, symbol) { - var declaration = symbol.valueDeclaration || symbol.declarations[0]; - var sourceFile = ts.getSourceFileOfNode(declaration); - if (declaration.type) { - return getType(sourceFile, declaration.type).trim(); - } else if (declaration.initializer) { - // The symbol does not have a "type" but it is being initialized - // so we can deduce the type of from the initializer (mostly). - if (declaration.initializer.expression) { - return declaration.initializer.expression.text.trim(); - } else { - return getType(sourceFile, declaration.initializer).trim(); - } - } - } - - - function expandSourceFiles(sourceFiles, basePath) { - var filePaths = []; - sourceFiles.forEach(function(sourcePattern) { - filePaths = filePaths.concat(glob.sync(sourcePattern, { cwd: basePath })); - }); - return filePaths; - } - - - function getText(sourceFile, node) { - return sourceFile.text.substring(node.pos, node.end); - } - - - // Strip any local renamed imports from the front of types - function getType(sourceFile, type) { - var text = getText(sourceFile, type); - while (text.indexOf(".") >= 0) { - // Keep namespaced symbols in RxNext - if (text.match(/^\s*RxNext\./)) break; - // handle the case List -> List - text = text.replace(/([^.<]*)\.([^>]*)/, "$2"); - } - return text; - } - - function getLocation(symbol) { - var node = symbol.valueDeclaration || symbol.declarations[0]; - var sourceFile = ts.getSourceFileOfNode(node); - var location = { - start: ts.getLineAndCharacterOfPosition(sourceFile, node.pos), - end: ts.getLineAndCharacterOfPosition(sourceFile, node.end) - }; - return location; - } - -}; - -function convertToRegexCollection(items) { - if (!items) return []; - - // Must be an array - if (!_.isArray(items)) { - items = [items]; - } - - // Convert string to exact matching regexes - return items.map(function(item) { - return _.isString(item) ? new RegExp('^' + item + '$') : item; - }); -} - -function anyMatches(regexes, item) { - for(var i=0; i']); - expect(exportedInterface.newMember).toBeDefined(); - expect(exportedInterface.newMember.parameters).toEqual(['param: number']); - expect(exportedInterface.newMember.returnType).toEqual('MyInterface'); - }); - }); - - - describe('ordering of members', function() { - it('should order class members in order of appearance (by default)', function() { - processor.sourceFiles = ['orderingOfMembers.ts']; - var docs = []; - processor.$process(docs); - var classDoc = _.find(docs, { docType: 'class' }); - expect(classDoc.docType).toEqual('class'); - expect(getNames(classDoc.members)).toEqual([ - 'firstItem', - 'otherMethod', - 'doStuff', - ]); - }); - - - it('should not order class members if not sortClassMembers is false', function() { - processor.sourceFiles = ['orderingOfMembers.ts']; - processor.sortClassMembers = false; - var docs = []; - processor.$process(docs); - var classDoc = _.find(docs, { docType: 'class' }); - expect(classDoc.docType).toEqual('class'); - expect(getNames(classDoc.members)).toEqual([ - 'firstItem', - 'otherMethod', - 'doStuff' - ]); - }); - }); -}); - -function getNames(collection) { - return collection.map(function(item) { return item.name; }); -} \ No newline at end of file diff --git a/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.js b/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.js deleted file mode 100755 index 69afdea89e..0000000000 --- a/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.js +++ /dev/null @@ -1,31 +0,0 @@ -var _ = require('lodash'); - -module.exports = function convertPrivateClassesToInterfaces() { - return function(exportDocs, addInjectableReference) { - _.forEach(exportDocs, function(exportDoc) { - - // Search for classes with a constructor marked as `@internal` - if (exportDoc.docType === 'class' && exportDoc.constructorDoc && exportDoc.constructorDoc.internal) { - - // Convert this class to an interface with no constructor - exportDoc.docType = 'interface'; - exportDoc.constructorDoc = null; - - if (exportDoc.heritage) { - // convert the heritage since interfaces use `extends` not `implements` - exportDoc.heritage = exportDoc.heritage.replace('implements', 'extends'); - } - - if (addInjectableReference) { - // Add the `declare var SomeClass extends InjectableReference` construct - exportDocs.push({ - docType: 'var', - name: exportDoc.name, - id: exportDoc.id, - returnType: 'InjectableReference' - }); - } - } - }); - }; -}; diff --git a/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js b/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js deleted file mode 100755 index bc4ed7411c..0000000000 --- a/scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js +++ /dev/null @@ -1,76 +0,0 @@ -var mockPackage = require('../mocks/mockPackage'); -var Dgeni = require('dgeni'); -var _ = require('lodash'); - -describe('readTypeScriptModules', function() { - var dgeni, injector, convertPrivateClassesToInterfaces; - - beforeEach(function() { - dgeni = new Dgeni([mockPackage()]); - injector = dgeni.configureInjector(); - convertPrivateClassesToInterfaces = injector.get('convertPrivateClassesToInterfaces'); - }); - - it('should convert private class docs to interface docs', function() { - var docs = [ - { - docType: 'class', - name: 'privateClass', - id: 'privateClass', - constructorDoc: { internal: true } - } - ]; - convertPrivateClassesToInterfaces(docs, false); - expect(docs[0].docType).toEqual('interface'); - }); - - - it('should not touch non-private class docs', function() { - var docs = [ - { - docType: 'class', - name: 'privateClass', - id: 'privateClass', - constructorDoc: { } - } - ]; - convertPrivateClassesToInterfaces(docs, false); - expect(docs[0].docType).toEqual('class'); - }); - - - it('should convert the heritage since interfaces use `extends` not `implements`', function() { - var docs = [ - { - docType: 'class', - name: 'privateClass', - id: 'privateClass', - constructorDoc: { internal: true }, - heritage: 'implements parentInterface' - } - ]; - convertPrivateClassesToInterfaces(docs, false); - expect(docs[0].heritage).toEqual('extends parentInterface'); - }); - - - it('should add new injectable reference types, if specified, to the passed in collection', function() { - var docs = [ - { - docType: 'class', - name: 'privateClass', - id: 'privateClass', - constructorDoc: { internal: true }, - heritage: 'implements parentInterface' - } - ]; - convertPrivateClassesToInterfaces(docs, true); - expect(docs[1]).toEqual({ - docType : 'var', - name : 'privateClass', - id : 'privateClass', - returnType : 'InjectableReference' - }); - }); - -}); diff --git a/scripts/docs/typescript-package/services/modules.js b/scripts/docs/typescript-package/services/modules.js deleted file mode 100755 index 7601390220..0000000000 --- a/scripts/docs/typescript-package/services/modules.js +++ /dev/null @@ -1,3 +0,0 @@ -module.exports = function modules() { - return {}; -}; diff --git a/scripts/docs/typescript-package/services/tsParser/createCompilerHost.js b/scripts/docs/typescript-package/services/tsParser/createCompilerHost.js deleted file mode 100755 index c9d3d368b4..0000000000 --- a/scripts/docs/typescript-package/services/tsParser/createCompilerHost.js +++ /dev/null @@ -1,80 +0,0 @@ -var ts = require('typescript'); -var fs = require('fs'); -var path = require('canonical-path'); - -// We need to provide our own version of CompilerHost because we want to set the -// base directory and specify what extensions to consider when trying to load a source -// file -module.exports = function createCompilerHost(log) { - - return function createCompilerHost(options, baseDir, extensions) { - - return { - getSourceFile: function(fileName, languageVersion, onError) { - var text, resolvedPath, resolvedPathWithExt; - - // Strip off the extension and resolve relative to the baseDir - baseFilePath = fileName.replace(/\.[^.]+$/, ''); - resolvedPath = path.resolve(baseDir, baseFilePath); - - // Iterate through each possible extension and return the first source file that is actually found - for(var i=0; i { const portal = this._appRoot._getPortal(appPortal); @@ -250,7 +250,7 @@ export class App { } /** - * @private + * @hidden */ goBack(): Promise { if (this._menuCtrl && this._menuCtrl.isOpen()) { @@ -270,7 +270,7 @@ export class App { } /** - * @private + * @hidden */ navPop(): Promise { if (!this._rootNav || !this.isEnabled()) { diff --git a/src/components/backdrop/backdrop.ts b/src/components/backdrop/backdrop.ts index 1f8d5c7ea7..c9b67e9ea6 100644 --- a/src/components/backdrop/backdrop.ts +++ b/src/components/backdrop/backdrop.ts @@ -1,7 +1,7 @@ import { Directive, ElementRef, Renderer } from '@angular/core'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-backdrop', diff --git a/src/components/button/button.ts b/src/components/button/button.ts index 4638c413cb..165a351d25 100644 --- a/src/components/button/button.ts +++ b/src/components/button/button.ts @@ -131,25 +131,25 @@ import { isTrueProperty } from '../../util/util'; encapsulation: ViewEncapsulation.None, }) export class Button extends Ion { - /** @private */ + /** @hidden */ _role: string = 'button'; // bar-button - /** @private */ + /** @hidden */ _size: string; // large/small/default - /** @private */ + /** @hidden */ _style: string = 'default'; // outline/clear/solid - /** @private */ + /** @hidden */ _shape: string; // round/fab - /** @private */ + /** @hidden */ _display: string; // block/full - /** @private */ + /** @hidden */ _decorator: string; // strong - /** @private */ + /** @hidden */ _init: boolean; /** @@ -245,7 +245,7 @@ export class Button extends Ion { this._assignCss(true); } - /** @private */ + /** @hidden */ _attr(type: string, attrName: string, attrValue: boolean) { if (type === '_style') { this._updateColor(this._color, false); @@ -297,14 +297,14 @@ export class Button extends Ion { } } - /** @private */ + /** @hidden */ ngAfterContentInit() { this._init = true; this._assignCss(true); } /** - * @private + * @hidden */ setRole(val: string) { this._assignCss(false); @@ -313,7 +313,7 @@ export class Button extends Ion { } /** - * @private + * @hidden */ _assignCss(assignCssClass: boolean) { let role = this._role; @@ -331,7 +331,7 @@ export class Button extends Ion { } /** - * @private + * @hidden */ _setClass(type: string, assignCssClass: boolean) { if (type && this._init) { @@ -342,7 +342,7 @@ export class Button extends Ion { } /** - * @private + * @hidden */ _updateColor(color: string, isAdd: boolean) { if (color && this._init) { diff --git a/src/components/card/card-content.ts b/src/components/card/card-content.ts index b29d815743..67aedf8568 100644 --- a/src/components/card/card-content.ts +++ b/src/components/card/card-content.ts @@ -4,7 +4,7 @@ import { Config } from '../../config/config'; import { Ion } from '../ion'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-card-content' diff --git a/src/components/card/card-header.ts b/src/components/card/card-header.ts index 8894cf4ac6..8ae81eaca5 100644 --- a/src/components/card/card-header.ts +++ b/src/components/card/card-header.ts @@ -4,7 +4,7 @@ import { Config } from '../../config/config'; import { Ion } from '../ion'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-card-header' diff --git a/src/components/card/card-title.ts b/src/components/card/card-title.ts index 1e9bf73349..0dd9319440 100644 --- a/src/components/card/card-title.ts +++ b/src/components/card/card-title.ts @@ -4,7 +4,7 @@ import { Config } from '../../config/config'; import { Ion } from '../ion'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-card-title' diff --git a/src/components/card/card.ts b/src/components/card/card.ts index 366abe0169..641d8dd401 100644 --- a/src/components/card/card.ts +++ b/src/components/card/card.ts @@ -5,7 +5,7 @@ import { Ion } from '../ion'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-card' diff --git a/src/components/checkbox/checkbox.ts b/src/components/checkbox/checkbox.ts index 5e704bf46b..c8344ae516 100644 --- a/src/components/checkbox/checkbox.ts +++ b/src/components/checkbox/checkbox.ts @@ -73,17 +73,17 @@ export const CHECKBOX_VALUE_ACCESSOR: any = { encapsulation: ViewEncapsulation.None, }) export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, ControlValueAccessor, OnDestroy { - /** @private */ + /** @hidden */ _checked: boolean = false; - /** @private */ + /** @hidden */ _init: boolean; - /** @private */ + /** @hidden */ _disabled: boolean = false; - /** @private */ + /** @hidden */ _labelId: string; - /** @private */ + /** @hidden */ _fn: Function; - /** @private */ + /** @hidden */ id: string; /** @@ -131,7 +131,7 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ @HostListener('click', ['$event']) _click(ev: UIEvent) { @@ -155,7 +155,7 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ _setChecked(isChecked: boolean) { if (isChecked !== this._checked) { @@ -168,14 +168,14 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ writeValue(val: any) { this._setChecked(isTrueProperty(val)); } /** - * @private + * @hidden */ registerOnChange(fn: Function): void { this._fn = fn; @@ -188,7 +188,7 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ registerOnTouched(fn: any) { this.onTouched = fn; } @@ -206,7 +206,7 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ onChange(isChecked: boolean) { // used when this input does not have an ngModel or formControlName @@ -217,33 +217,33 @@ export class Checkbox extends Ion implements IonicTapInput, AfterContentInit, Co } /** - * @private + * @hidden */ initFocus() { this._elementRef.nativeElement.querySelector('button').focus(); } /** - * @private + * @hidden */ onTouched() { } /** - * @private + * @hidden */ ngAfterContentInit() { this._init = true; } /** - * @private + * @hidden */ setDisabledState(isDisabled: boolean) { this.disabled = isDisabled; } /** - * @private + * @hidden */ ngOnDestroy() { this._form.deregister(this); diff --git a/src/components/content/content.ts b/src/components/content/content.ts index 4fe7b09ea0..84dec0ae89 100644 --- a/src/components/content/content.ts +++ b/src/components/content/content.ts @@ -183,7 +183,7 @@ export class Content extends Ion implements OnDestroy, OnInit { private _imgRndBfr: number; private _imgVelMax: number; - /** @private */ + /** @hidden */ statusbarPadding: boolean; /** @@ -372,7 +372,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ ngOnInit() { if (this._scrollEle) return; @@ -410,7 +410,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ ngOnDestroy() { this._scLsn && this._scLsn(); @@ -422,14 +422,14 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ getScrollElement(): HTMLElement { return this._scrollEle; } /** - * @private + * @hidden */ onScrollElementTransitionEnd(callback: {(ev: TransitionEvent): void}) { this._plt.transitionEnd(this._scrollEle, callback); @@ -471,7 +471,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ enableJsScroll() { this._scroll.enableJsScroll(this._cTop, this._cBottom); @@ -492,21 +492,21 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ addImg(img: Img) { this._imgs.push(img); } /** - * @private + * @hidden */ removeImg(img: Img) { removeArrayItem(this._imgs, img); } /** - * @private + * @hidden * DOM WRITE */ setScrollElementStyle(prop: string, val: any) { @@ -559,7 +559,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden * DOM WRITE * Adds padding to the bottom of the scroll element when the keyboard is open * so content below the keyboard can be scrolled into view. @@ -581,7 +581,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden * DOM WRITE */ clearScrollPaddingFocusOut() { @@ -608,7 +608,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden * DOM READ */ private _readDimensions() { @@ -754,7 +754,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden * DOM WRITE */ private _writeDimensions() { @@ -842,7 +842,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ imgsUpdate() { if (this._scroll.initialized && this._imgs.length && this.isImgsUpdatable()) { @@ -851,7 +851,7 @@ export class Content extends Ion implements OnDestroy, OnInit { } /** - * @private + * @hidden */ isImgsUpdatable() { // an image is only "updatable" if the content isn't scrolling too fast diff --git a/src/components/datetime/datetime.ts b/src/components/datetime/datetime.ts index 25c765a25e..a7a63b8487 100644 --- a/src/components/datetime/datetime.ts +++ b/src/components/datetime/datetime.ts @@ -280,7 +280,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces _locale: LocaleData = {}; /** - * @private + * @hidden */ id: string; @@ -473,7 +473,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ open() { if (this._disabled) { @@ -520,7 +520,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ generate(picker: Picker) { // if a picker format wasn't provided, then fallback @@ -588,7 +588,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ validate(picker: Picker) { let i: number; @@ -679,7 +679,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ divyColumns(picker: Picker) { let pickerColumns = picker.getColumns(); @@ -712,21 +712,21 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ setValue(newData: any) { updateDate(this._value, newData); } /** - * @private + * @hidden */ getValue(): DateTimeData { return this._value; } /** - * @private + * @hidden */ checkHasValue(inputValue: any) { if (this._item) { @@ -735,7 +735,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ updateText() { // create the text of the formatted data @@ -744,7 +744,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ calcMinMax(now?: Date) { const todaysYear = (now || new Date()).getFullYear(); @@ -807,7 +807,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ writeValue(val: any) { console.debug('datetime, writeValue', val); @@ -817,7 +817,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ ngAfterContentInit() { // first see if locale names were provided in the inputs @@ -832,7 +832,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ registerOnChange(fn: Function): void { this._fn = fn; @@ -850,12 +850,12 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ registerOnTouched(fn: any) { this.onTouched = fn; } /** - * @private + * @hidden */ onChange(val: any) { // onChange used when there is not an formControlName @@ -867,19 +867,19 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden */ onTouched() { } /** - * @private + * @hidden */ setDisabledState(isDisabled: boolean) { this.disabled = isDisabled; } /** - * @private + * @hidden */ ngOnDestroy() { this._form.deregister(this); @@ -887,7 +887,7 @@ export class DateTime extends Ion implements AfterContentInit, ControlValueAcces } /** - * @private + * @hidden * Use to convert a string of comma separated numbers or * an array of numbers, and clean up any user input */ @@ -918,7 +918,7 @@ function convertToArrayOfNumbers(input: any, type: string): number[] { } /** - * @private + * @hidden * Use to convert a string of comma separated strings or * an array of strings, and clean up any user input */ diff --git a/src/components/fab/fab-container.ts b/src/components/fab/fab-container.ts index 0c254a67d1..08b0e1cffc 100644 --- a/src/components/fab/fab-container.ts +++ b/src/components/fab/fab-container.ts @@ -93,22 +93,22 @@ import { FabList } from './fab-list'; export class FabContainer { /** - * @private + * @hidden */ _events: UIEventManager; /** - * @private + * @hidden */ _listsActive: boolean = false; /** - * @private + * @hidden */ @ContentChild(FabButton) _mainButton: FabButton; /** - * @private + * @hidden */ @ContentChildren(FabList) _fabLists: QueryList; @@ -117,7 +117,7 @@ export class FabContainer { } /** - * @private + * @hidden */ ngAfterContentInit() { const mainButton = this._mainButton; @@ -129,7 +129,7 @@ export class FabContainer { } /** - * @private + * @hidden */ clickHandler(ev: any) { if (this.canActivateList(ev)) { @@ -138,7 +138,7 @@ export class FabContainer { } /** - * @private + * @hidden */ canActivateList(ev: any): boolean { if (this._fabLists.length > 0 && this._mainButton && ev.target) { @@ -149,14 +149,14 @@ export class FabContainer { } /** - * @private + * @hidden */ toggleList() { this.setActiveLists(!this._listsActive); } /** - * @private + * @hidden */ setActiveLists(isActive: boolean) { if (isActive === this._listsActive) { @@ -178,7 +178,7 @@ export class FabContainer { } /** - * @private + * @hidden */ ngOnDestroy() { this._events.destroy(); diff --git a/src/components/fab/fab-list.ts b/src/components/fab/fab-list.ts index 34516a0a0f..13cc712f60 100644 --- a/src/components/fab/fab-list.ts +++ b/src/components/fab/fab-list.ts @@ -58,7 +58,7 @@ export class FabList { } /** - * @private + * @hidden */ setVisible(val: boolean) { let visible = isTrueProperty(val); diff --git a/src/components/fab/fab.ts b/src/components/fab/fab.ts index 47af1d81ab..1cfd30833c 100755 --- a/src/components/fab/fab.ts +++ b/src/components/fab/fab.ts @@ -91,7 +91,7 @@ export class FabButton extends Ion { /** - * @private + * @hidden */ setActiveClose(closeVisible: boolean) { this.setElementClass('fab-close-active', closeVisible); diff --git a/src/components/icon/icon.ts b/src/components/icon/icon.ts index 6661dd2f45..13635e8f30 100644 --- a/src/components/icon/icon.ts +++ b/src/components/icon/icon.ts @@ -43,17 +43,17 @@ import { Ion } from '../ion'; } }) export class Icon extends Ion { - /** @private */ + /** @hidden */ _iconMode: string; - /** @private */ + /** @hidden */ _isActive: boolean = true; - /** @private */ + /** @hidden */ _name: string = ''; - /** @private */ + /** @hidden */ _ios: string = ''; - /** @private */ + /** @hidden */ _md: string = ''; - /** @private */ + /** @hidden */ _css: string = ''; /** @@ -89,7 +89,7 @@ export class Icon extends Ion { } /** - * @private + * @hidden */ ngOnDestroy() { if (this._css) { @@ -160,12 +160,12 @@ export class Icon extends Ion { } /** - * @private + * @hidden */ @HostBinding('class.hide') _hidden: boolean = false; /** - * @private + * @hidden */ update() { let iconName: string; diff --git a/src/components/img/img.ts b/src/components/img/img.ts index c6eeb33259..4ff4f5e09f 100644 --- a/src/components/img/img.ts +++ b/src/components/img/img.ts @@ -123,9 +123,9 @@ export class Img implements OnDestroy { /** @internal */ _unreg: Function; - /** @private */ + /** @hidden */ canRequest: boolean; - /** @private */ + /** @hidden */ canRender: boolean; @@ -178,7 +178,7 @@ export class Img implements OnDestroy { } /** - * @private + * @hidden */ reset() { if (this._requestingSrc) { @@ -196,7 +196,7 @@ export class Img implements OnDestroy { } /** - * @private + * @hidden */ update() { // only attempt an update if there is an active src @@ -255,7 +255,7 @@ export class Img implements OnDestroy { } /** - * @private + * @hidden */ get top(): number { const bounds = this._getBounds(); @@ -263,7 +263,7 @@ export class Img implements OnDestroy { } /** - * @private + * @hidden */ get bottom(): number { const bounds = this._getBounds(); @@ -360,7 +360,7 @@ export class Img implements OnDestroy { @Input() alt: string = ''; /** - * @private + * @hidden */ ngAfterContentInit() { this._img = this._elementRef.nativeElement.firstChild; @@ -372,7 +372,7 @@ export class Img implements OnDestroy { } /** - * @private + * @hidden */ ngOnDestroy() { this._unreg && this._unreg(); diff --git a/src/components/infinite-scroll/infinite-scroll-content.ts b/src/components/infinite-scroll/infinite-scroll-content.ts index d917aae727..102814657d 100644 --- a/src/components/infinite-scroll/infinite-scroll-content.ts +++ b/src/components/infinite-scroll/infinite-scroll-content.ts @@ -5,7 +5,7 @@ import { InfiniteScroll } from './infinite-scroll'; /** - * @private + * @hidden */ @Component({ selector: 'ion-infinite-scroll-content', @@ -36,7 +36,7 @@ export class InfiniteScrollContent { constructor(public inf: InfiniteScroll, private _config: Config) {} /** - * @private + * @hidden */ ngOnInit() { if (!this.loadingSpinner) { diff --git a/src/components/infinite-scroll/infinite-scroll.ts b/src/components/infinite-scroll/infinite-scroll.ts index cf2008ab81..f746e4eed6 100644 --- a/src/components/infinite-scroll/infinite-scroll.ts +++ b/src/components/infinite-scroll/infinite-scroll.ts @@ -239,7 +239,7 @@ export class InfiniteScroll { } /** - * @private + * @hidden */ _setListeners(shouldListen: boolean) { if (this._init) { @@ -257,7 +257,7 @@ export class InfiniteScroll { } /** - * @private + * @hidden */ ngAfterContentInit() { this._init = true; @@ -265,7 +265,7 @@ export class InfiniteScroll { } /** - * @private + * @hidden */ ngOnDestroy() { this._setListeners(false); diff --git a/src/components/input/input.ts b/src/components/input/input.ts index d258727600..5992367865 100644 --- a/src/components/input/input.ts +++ b/src/components/input/input.ts @@ -115,7 +115,7 @@ export class TextInput extends Ion implements IonicFormInput { _usePadding: boolean; _value: any = ''; - /** @private */ + /** @hidden */ inputControl: NgControl; constructor( @@ -227,7 +227,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setDisabled(val: boolean) { this._renderer.setElementAttribute(this._elementRef.nativeElement, 'disabled', val ? '' : null); @@ -236,7 +236,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setDisabledState(isDisabled: boolean) { this.disabled = isDisabled; @@ -286,7 +286,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setMin(val: any) { this._native && this._native.setMin(val); @@ -304,7 +304,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setMax(val: any) { this._native && this._native.setMax(val); @@ -322,14 +322,14 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setStep(val: any) { this._native && this._native.setStep(val); } /** - * @private + * @hidden */ @ViewChild('input', { read: NativeInput }) set _nativeInput(nativeInput: NativeInput) { @@ -339,7 +339,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ @ViewChild('textarea', { read: NativeInput }) set _nativeTextarea(nativeInput: NativeInput) { @@ -349,7 +349,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ @ViewChild(NextInput) set _nextInput(nextInput: NextInput) { @@ -371,7 +371,7 @@ export class TextInput extends Ion implements IonicFormInput { @Output() focus: EventEmitter = new EventEmitter(); /** - * @private + * @hidden */ setNativeInput(nativeInput: NativeInput) { this._native = nativeInput; @@ -446,7 +446,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ initFocus() { // begin the process of setting focus to the inner input element @@ -523,7 +523,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ setFocus() { // immediately set focus @@ -540,7 +540,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ scrollHideFocus(ev: ScrollEvent, shouldHideFocus: boolean) { // do not continue if there's no nav, or it's transitioning @@ -553,21 +553,21 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ inputBlurred(ev: UIEvent) { this.blur.emit(ev); } /** - * @private + * @hidden */ inputFocused(ev: UIEvent) { this.focus.emit(ev); } /** - * @private + * @hidden */ writeValue(val: any) { this._value = val; @@ -575,14 +575,14 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ onChange(val: any) { this.checkHasValue(val); } /** - * @private + * @hidden */ onKeydown(val: any) { if (this._clearOnEdit) { @@ -591,12 +591,12 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ onTouched(val: any) {} /** - * @private + * @hidden */ hasFocus(): boolean { // check if an input has focus or not @@ -604,7 +604,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ hasValue(): boolean { const inputValue = this._value; @@ -612,7 +612,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ checkHasValue(inputValue: any) { if (this._item) { @@ -622,7 +622,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ focusChange(inputHasFocus: boolean) { if (this._item) { @@ -637,7 +637,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ pointerStart(ev: UIEvent) { // input cover touchstart @@ -654,7 +654,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ pointerEnd(ev: UIEvent) { // input cover touchend/mouseup @@ -684,7 +684,7 @@ export class TextInput extends Ion implements IonicFormInput { this._coord = null; } /** - * @private + * @hidden */ setItemInputControlCss() { let item = this._item; @@ -703,7 +703,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ ngOnInit() { const item = this._item; @@ -722,14 +722,14 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ ngAfterContentChecked() { this.setItemInputControlCss(); } /** - * @private + * @hidden */ ngOnDestroy() { this._form.deregister(this); @@ -742,7 +742,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden */ clearTextInput() { console.debug('Should clear input'); @@ -753,7 +753,7 @@ export class TextInput extends Ion implements IonicFormInput { /** * Check if we need to clear the text input if clearOnEdit is enabled - * @private + * @hidden */ checkClearOnEdit(inputValue: string) { if (!this._clearOnEdit) { @@ -771,7 +771,7 @@ export class TextInput extends Ion implements IonicFormInput { } /** - * @private + * @hidden * Angular2 Forms API method called by the view (formControlName) to register the * onChange event handler that updates the model (Control). * @param {Function} fn the onChange event handler. @@ -779,7 +779,7 @@ export class TextInput extends Ion implements IonicFormInput { registerOnChange(fn: any) { this.onChange = fn; } /** - * @private + * @hidden * Angular2 Forms API method called by the view (formControlName) to register * the onTouched event handler that marks model (Control) as touched. * @param {Function} fn onTouched event handler. @@ -788,7 +788,7 @@ export class TextInput extends Ion implements IonicFormInput { /** - * @private + * @hidden */ focusNext() { this._form.tabFocus(this); @@ -848,7 +848,7 @@ const TEXT_TYPE_REGEX = /password|email|number|search|tel|url|date|month|time|we /** - * @private + * @hidden */ export function getScrollData(inputOffsetTop: number, inputOffsetHeight: number, scrollViewDimensions: ContentDimensions, keyboardHeight: number, plaformHeight: number) { // compute input's Y values relative to the body diff --git a/src/components/input/native-input.ts b/src/components/input/native-input.ts index 31775a4ef1..3ef87a73ba 100644 --- a/src/components/input/native-input.ts +++ b/src/components/input/native-input.ts @@ -6,7 +6,7 @@ import { Platform } from '../../platform/platform'; /** - * @private + * @hidden */ @Directive({ selector: '.text-input' diff --git a/src/components/input/next-input.ts b/src/components/input/next-input.ts index 45b2f04e0f..3f0858fc9c 100644 --- a/src/components/input/next-input.ts +++ b/src/components/input/next-input.ts @@ -1,7 +1,7 @@ import { Directive, EventEmitter, HostListener, Output } from '@angular/core'; /** - * @private + * @hidden */ @Directive({ selector: '[next-input]' diff --git a/src/components/ion.ts b/src/components/ion.ts index fc305edc07..16ba4aa975 100644 --- a/src/components/ion.ts +++ b/src/components/ion.ts @@ -8,22 +8,22 @@ import { Config } from '../config/config'; * sending/receiving app-level events. */ export class Ion { - /** @private */ + /** @hidden */ _config: Config; - /** @private */ + /** @hidden */ _elementRef: ElementRef; - /** @private */ + /** @hidden */ _renderer: Renderer; - /** @private */ + /** @hidden */ _color: string; - /** @private */ + /** @hidden */ _mode: string; - /** @private */ + /** @hidden */ _componentName: string; constructor(config: Config, elementRef: ElementRef, renderer: Renderer, componentName?: string) { @@ -38,22 +38,22 @@ export class Ion { } } - /** @private */ + /** @hidden */ setElementClass(className: string, isAdd: boolean) { this._renderer.setElementClass(this._elementRef.nativeElement, className, isAdd); } - /** @private */ + /** @hidden */ setElementAttribute(attributeName: string, attributeValue: any) { this._renderer.setElementAttribute(this._elementRef.nativeElement, attributeName, attributeValue); } - /** @private */ + /** @hidden */ setElementStyle(property: string, value: string) { this._renderer.setElementStyle(this._elementRef.nativeElement, property, value); } - /** @private */ + /** @hidden */ _setColor(newColor: string, componentName?: string) { if (componentName) { // This is needed for the item-radio @@ -68,7 +68,7 @@ export class Ion { } } - /** @private */ + /** @hidden */ _setMode(newMode: string) { if (this._mode) { this.setElementClass(`${this._componentName}-${this._mode}`, false); @@ -84,17 +84,17 @@ export class Ion { } } - /** @private */ + /** @hidden */ _setComponentName() { this.setElementClass(this._componentName, true); } - /** @private */ + /** @hidden */ getElementRef(): ElementRef { return this._elementRef; } - /** @private */ + /** @hidden */ getNativeElement(): any { return this._elementRef.nativeElement; } diff --git a/src/components/item/item-content.ts b/src/components/item/item-content.ts index 672482eb03..8a36007e48 100644 --- a/src/components/item/item-content.ts +++ b/src/components/item/item-content.ts @@ -1,7 +1,7 @@ import { Directive } from '@angular/core'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-item,[ion-item]', diff --git a/src/components/item/item-divider.ts b/src/components/item/item-divider.ts index 9c568117da..3c7b5481ac 100644 --- a/src/components/item/item-divider.ts +++ b/src/components/item/item-divider.ts @@ -5,7 +5,7 @@ import { Form } from '../../util/form'; import { Ion } from '../ion'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-item-divider', diff --git a/src/components/item/item-group.ts b/src/components/item/item-group.ts index 60ad3028f1..560a615e99 100644 --- a/src/components/item/item-group.ts +++ b/src/components/item/item-group.ts @@ -1,7 +1,7 @@ import { Directive } from '@angular/core'; /** - * @private + * @hidden */ @Directive({ selector: 'ion-item-group' diff --git a/src/components/item/item-options.ts b/src/components/item/item-options.ts index 784fe71b56..781a6bf60e 100644 --- a/src/components/item/item-options.ts +++ b/src/components/item/item-options.ts @@ -42,7 +42,7 @@ export class ItemOptions { constructor(private _elementRef: ElementRef, private _renderer: Renderer) {} /** - * @private + * @hidden */ getSides(): number { if (isPresent(this.side) && this.side === 'left') { @@ -52,7 +52,7 @@ export class ItemOptions { } /** - * @private + * @hidden */ width() { return this._elementRef.nativeElement.offsetWidth; diff --git a/src/components/item/item-reorder-gesture.ts b/src/components/item/item-reorder-gesture.ts index dbbba4616d..26b007d8fb 100644 --- a/src/components/item/item-reorder-gesture.ts +++ b/src/components/item/item-reorder-gesture.ts @@ -5,7 +5,7 @@ import { UIEventManager } from '../../gestures/ui-event-manager'; /** - * @private + * @hidden */ export class ItemReorderGesture { private selectedItemEle: HTMLElement = null; @@ -150,7 +150,7 @@ export class ItemReorderGesture { } /** - * @private + * @hidden */ destroy() { this.onDragEnd(null); diff --git a/src/components/item/item-reorder-util.ts b/src/components/item/item-reorder-util.ts index e75be84877..0da4082eb3 100644 --- a/src/components/item/item-reorder-util.ts +++ b/src/components/item/item-reorder-util.ts @@ -1,19 +1,19 @@ /** - * @private + * @hidden */ export function indexForItem(element: any): number { return element['$ionIndex']; } /** - * @private + * @hidden */ export function reorderListForItem(element: any): any { return element['$ionReorderList']; } /** - * @private + * @hidden */ export function findReorderItem(node: any, listNode: any): HTMLElement { let nested = 0; diff --git a/src/components/item/item-reorder.ts b/src/components/item/item-reorder.ts index 4b952df69b..05cc0c7bb2 100644 --- a/src/components/item/item-reorder.ts +++ b/src/components/item/item-reorder.ts @@ -170,7 +170,7 @@ export class ItemReorder implements ItemReorderGestureDelegate { } /** - * @private + * @hidden */ ngOnDestroy() { this._element = null; @@ -178,7 +178,7 @@ export class ItemReorder implements ItemReorderGestureDelegate { } /** - * @private + * @hidden */ @Input() get reorder(): boolean { @@ -287,14 +287,14 @@ export class ItemReorder implements ItemReorderGestureDelegate { } /** - * @private + * @hidden */ setElementClass(classname: string, add: boolean) { this._rendered.setElementClass(this._element, classname, add); } /** - * @private + * @hidden */ getNativeElement(): HTMLElement { return this._element; diff --git a/src/components/item/item-sliding-gesture.ts b/src/components/item/item-sliding-gesture.ts index a1d3cc4037..2e34d91266 100644 --- a/src/components/item/item-sliding-gesture.ts +++ b/src/components/item/item-sliding-gesture.ts @@ -7,7 +7,7 @@ import { Platform } from '../../platform/platform'; import { pointerCoord } from '../../util/dom'; /** - * @private + * @hidden */ export class ItemSlidingGesture extends PanGesture { diff --git a/src/components/item/item-sliding.ts b/src/components/item/item-sliding.ts index a9c42d0fa8..d7a12796cc 100644 --- a/src/components/item/item-sliding.ts +++ b/src/components/item/item-sliding.ts @@ -133,7 +133,7 @@ export class ItemSliding { private _state: SlidingState = SlidingState.Disabled; /** - * @private + * @hidden */ @ContentChild(Item) item: Item; @@ -193,14 +193,14 @@ export class ItemSliding { } /** - * @private + * @hidden */ getOpenAmount(): number { return this._openAmount; } /** - * @private + * @hidden */ getSlidingPercent(): number { let openAmount = this._openAmount; @@ -214,7 +214,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ startSliding(startX: number) { if (this._tmr) { @@ -230,7 +230,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ moveSliding(x: number): number { if (this._optsDirty) { @@ -263,7 +263,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ endSliding(velocity: number): number { let restingPoint = (this._openAmount > 0) @@ -285,7 +285,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ private fireSwipeEvent() { if (this._state & SlidingState.SwipeRight) { @@ -296,7 +296,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ private calculateOptsWidth() { if (!this._optsDirty) { @@ -412,7 +412,7 @@ export class ItemSliding { } /** - * @private + * @hidden */ setElementClass(cssClass: string, shouldAdd: boolean) { this._renderer.setElementClass(this._elementRef.nativeElement, cssClass, shouldAdd); diff --git a/src/components/item/item.ts b/src/components/item/item.ts index d3cc977e17..4057d70194 100644 --- a/src/components/item/item.ts +++ b/src/components/item/item.ts @@ -302,12 +302,12 @@ export class Item extends Ion { _hasReorder: boolean; /** - * @private + * @hidden */ id: string; /** - * @private + * @hidden */ labelId: string = null; @@ -357,7 +357,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ registerInput(type: string) { this._inputs.push(type); @@ -365,7 +365,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ ngAfterContentInit() { if (this._viewLabel && this._inputs.length) { @@ -379,7 +379,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ _updateColor(newColor: string, componentName?: string) { componentName = componentName || 'item'; // item-radio @@ -387,7 +387,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ _setName(elementRef: ElementRef) { let nodeName = elementRef.nativeElement.nodeName.replace('ION-', ''); @@ -398,14 +398,14 @@ export class Item extends Ion { } /** - * @private + * @hidden */ getLabelText(): string { return this._label ? this._label.text : ''; } /** - * @private + * @hidden */ @ContentChild(Label) set contentLabel(label: Label) { @@ -420,7 +420,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ @ViewChild(Label) set viewLabel(label: Label) { @@ -430,7 +430,7 @@ export class Item extends Ion { } /** - * @private + * @hidden */ @ContentChildren(Button) set _buttons(buttons: QueryList