From ba3487dd555b745b39be35511e7aed298763b640 Mon Sep 17 00:00:00 2001 From: Ibby Date: Mon, 13 Mar 2017 16:00:28 -0400 Subject: [PATCH] chore(docs): update to latest dgeni version --- package.json | 8 +- scripts/docs/dgeni-config.js | 13 +- scripts/docs/dgeni-readmes-config.js | 23 +- scripts/docs/links-package/index.js | 12 - .../links-package/inline-tag-defs/link.js | 33 -- .../links-package/services/getLinkInfo.js | 72 --- scripts/docs/processors/hide-private-api.js | 10 +- .../docs/processors/remove-private-members.js | 7 +- scripts/docs/tag-defs/tag-defs.js | 1 + .../typescript-definition-package/index.js | 100 ---- .../mocks/mockPackage.js | 11 - .../processors/createTypeDefinitionFile.js | 86 ---- .../createTypeDefinitionFile.spec.js | 48 -- .../angular2/angular2.d.ts.template.html | 17 - .../templates/type-definition.template.html | 71 --- scripts/docs/typescript-package/index.js | 74 --- .../typescript-package/mocks/mockPackage.js | 11 - .../ignoreExportsMatching.ts | 4 - .../mocks/readTypeScriptModules/interfaces.ts | 5 - .../orderingOfMembers.ts | 6 - .../readTypeScriptModules/privateModule.ts | 1 - .../readTypeScriptModules/publicModule.ts | 3 - .../mocks/tsParser/importedSrc.ts | 1 - .../mocks/tsParser/testSrc.ts | 34 -- .../processors/readTypeScriptModules.js | 454 ------------------ .../processors/readTypeScriptModules.spec.js | 136 ------ .../convertPrivateClassesToInterfaces.js | 31 -- .../convertPrivateClassesToInterfaces.spec.js | 76 --- .../typescript-package/services/modules.js | 3 - .../services/tsParser/createCompilerHost.js | 80 --- .../tsParser/createCompilerHost.spec.js | 80 --- .../services/tsParser/getContent.js | 49 -- .../services/tsParser/getDirectiveInfo.js | 34 -- .../services/tsParser/getExportDocType.js | 54 --- .../services/tsParser/getFileInfo.js | 20 - .../services/tsParser/index.js | 74 --- .../services/tsParser/index.spec.js | 21 - src/@ionic-native/plugins/ad-mob/index.ts | 17 +- .../plugins/barcode-scanner/index.ts | 10 +- src/@ionic-native/plugins/calendar/index.ts | 14 - src/@ionic-native/plugins/camera/index.ts | 24 +- src/@ionic-native/plugins/contacts/index.ts | 23 +- .../plugins/date-picker/index.ts | 2 +- src/@ionic-native/plugins/db-meter/index.ts | 2 +- src/@ionic-native/plugins/file/index.ts | 20 +- .../plugins/google-maps/index.ts | 58 +-- src/@ionic-native/plugins/gyroscope/index.ts | 4 +- src/@ionic-native/plugins/health/index.ts | 8 +- .../plugins/in-app-browser/index.ts | 2 +- src/@ionic-native/plugins/media/index.ts | 20 +- src/@ionic-native/plugins/mixpanel/index.ts | 6 +- src/@ionic-native/plugins/nfc/index.ts | 2 +- src/@ionic-native/plugins/pay-pal/index.ts | 12 +- .../plugins/photo-library/index.ts | 10 +- src/@ionic-native/plugins/push/index.ts | 2 +- .../plugins/secure-storage/index.ts | 2 +- src/@ionic-native/plugins/sqlite/index.ts | 2 +- .../plugins/themeable-browser/index.ts | 2 +- 58 files changed, 141 insertions(+), 1864 deletions(-) delete mode 100644 scripts/docs/links-package/index.js delete mode 100644 scripts/docs/links-package/inline-tag-defs/link.js delete mode 100644 scripts/docs/links-package/services/getLinkInfo.js delete mode 100644 scripts/docs/typescript-definition-package/index.js delete mode 100644 scripts/docs/typescript-definition-package/mocks/mockPackage.js delete mode 100644 scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.js delete mode 100644 scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js delete mode 100644 scripts/docs/typescript-definition-package/templates/angular2/angular2.d.ts.template.html delete mode 100644 scripts/docs/typescript-definition-package/templates/type-definition.template.html delete mode 100755 scripts/docs/typescript-package/index.js delete mode 100755 scripts/docs/typescript-package/mocks/mockPackage.js delete mode 100755 scripts/docs/typescript-package/mocks/readTypeScriptModules/ignoreExportsMatching.ts delete mode 100755 scripts/docs/typescript-package/mocks/readTypeScriptModules/interfaces.ts delete mode 100755 scripts/docs/typescript-package/mocks/readTypeScriptModules/orderingOfMembers.ts delete mode 100755 scripts/docs/typescript-package/mocks/readTypeScriptModules/privateModule.ts delete mode 100755 scripts/docs/typescript-package/mocks/readTypeScriptModules/publicModule.ts delete mode 100755 scripts/docs/typescript-package/mocks/tsParser/importedSrc.ts delete mode 100755 scripts/docs/typescript-package/mocks/tsParser/testSrc.ts delete mode 100755 scripts/docs/typescript-package/processors/readTypeScriptModules.js delete mode 100755 scripts/docs/typescript-package/processors/readTypeScriptModules.spec.js delete mode 100755 scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.js delete mode 100755 scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js delete mode 100755 scripts/docs/typescript-package/services/modules.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/createCompilerHost.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/createCompilerHost.spec.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/getContent.js delete mode 100644 scripts/docs/typescript-package/services/tsParser/getDirectiveInfo.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/getExportDocType.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/getFileInfo.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/index.js delete mode 100755 scripts/docs/typescript-package/services/tsParser/index.spec.js diff --git a/package.json b/package.json index 5a809d85f..950f76768 100644 --- a/package.json +++ b/package.json @@ -20,8 +20,8 @@ "cpr": "^2.0.2", "cz-conventional-changelog": "^1.2.0", "decamelize": "^1.2.0", - "dgeni": "^0.4.2", - "dgeni-packages": "^0.10.18", + "dgeni": "^0.4.7", + "dgeni-packages": "^0.16.10", "es6-shim": "~0.35.2", "fs-extra": "^2.0.0", "fs-extra-promise": "^0.4.1", @@ -78,5 +78,9 @@ "commitizen": { "path": "./node_modules/cz-conventional-changelog" } + }, + "dependencies": { + "dgeni": "^0.4.7", + "dgeni-packages": "^0.16.10" } } diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index ef2ce6a65..7f0f87530 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 path = require('path'); var semver = require('semver'); var fs = require('fs'); @@ -13,9 +13,7 @@ var projectPackage = require('../../package.json'); // Define the dgeni package for generating the docs module.exports = function(currentVersion) { - return new Package('ionic-v2-docs', - [jsdocPackage, nunjucksPackage, typescriptPackage, - linksPackage]) + return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) // .processor(require('./processors/latest-version')) .processor(require('./processors/jekyll')) @@ -115,8 +113,7 @@ module.exports = function(currentVersion) { readFilesProcessor.$enabled = false; readFilesProcessor.basePath = path.resolve(__dirname, '../..'); - readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, - '../..')); + readTypeScriptModules.basePath = path.resolve(__dirname, '../..'); readTypeScriptModules.sourceFiles = [ './src/@ionic-native/plugins/**/*.ts' ]; @@ -146,7 +143,7 @@ module.exports = function(currentVersion) { // Configure file writing .config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = './src/@ionic-native/plugins2/'; + writeFilesProcessor.outputFolder = '../ionic-site/'; }) // Configure rendering diff --git a/scripts/docs/dgeni-readmes-config.js b/scripts/docs/dgeni-readmes-config.js index 80cf68714..d681a2a16 100644 --- a/scripts/docs/dgeni-readmes-config.js +++ b/scripts/docs/dgeni-readmes-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 path = require('path'); var semver = require('semver'); var fs = require('fs'); @@ -15,15 +15,13 @@ var projectPackage = require('../../package.json'); // Define the dgeni package for generating the docs module.exports = function(currentVersion) { - return new Package('ionic-v2-docs', - [jsdocPackage, nunjucksPackage, typescriptPackage, - linksPackage]) + return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) // .processor(require('./processors/latest-version')) .processor(require('./processors/readmes')) -.processor(require('./processors/remove-private-members')) -.processor(require('./processors/hide-private-api')) -.processor(require('./processors/collect-inputs-outputs')) +// .processor(require('./processors/remove-private-members')) +// .processor(require('./processors/hide-private-api')) +// .processor(require('./processors/collect-inputs-outputs')) // for debugging docs // .processor(function test(){ @@ -99,7 +97,7 @@ module.exports = function(currentVersion) { renderDocsProcessor.extraData.version = versionData; computePathsProcessor.pathTemplates = [{ - docTypes: ['class', 'var', 'function', 'let'], + docTypes: ['class'], getOutputPath: function(doc) { return doc.originalModule.replace(config.pluginDir + '/', '') .replace('/index', '') + '/README.md'; @@ -114,11 +112,8 @@ module.exports = function(currentVersion) { readFilesProcessor.$enabled = false; readFilesProcessor.basePath = path.resolve(__dirname, '../..'); - readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, - '../..')); - readTypeScriptModules.sourceFiles = [ - './src/@ionic-native/plugins/**/*.ts' - ]; + readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../..')); + readTypeScriptModules.sourceFiles = ['./src/@ionic-native/plugins/**/*.ts']; }) .config(function(parseTagsProcessor) { diff --git a/scripts/docs/links-package/index.js b/scripts/docs/links-package/index.js deleted file mode 100644 index a3ffc7199..000000000 --- a/scripts/docs/links-package/index.js +++ /dev/null @@ -1,12 +0,0 @@ -var Package = require('dgeni').Package; - -module.exports = new Package('links', []) - -.factory(require('./inline-tag-defs/link')) -.factory(require('dgeni-packages/ngdoc/services/getAliases')) -.factory(require('dgeni-packages/ngdoc/services/getDocFromAlias')) -.factory(require('./services/getLinkInfo')) - -.config(function(inlineTagProcessor, linkInlineTagDef) { - inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef); -}); diff --git a/scripts/docs/links-package/inline-tag-defs/link.js b/scripts/docs/links-package/inline-tag-defs/link.js deleted file mode 100644 index 89272c63c..000000000 --- a/scripts/docs/links-package/inline-tag-defs/link.js +++ /dev/null @@ -1,33 +0,0 @@ -var INLINE_LINK = /(\S+)(?:\s+([\s\S]+))?/; - -/** - * @dgService linkInlineTagDef - * @description - * Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors - * @kind function - * @param {Object} url The url to match - * @param {Function} docs error message - * @return {String} The html link information - * - * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc - */ -module.exports = function linkInlineTagDef(getLinkInfo, createDocMessage, log) { - return { - name: 'link', - description: 'Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors', - handler: function(doc, tagName, tagDescription) { - - // Parse out the uri and title - return tagDescription.replace(INLINE_LINK, function(match, uri, title) { - - var linkInfo = getLinkInfo(uri, title, doc); - - if ( !linkInfo.valid ) { - log.warn(createDocMessage(linkInfo.error, doc)); - } - - return "" + linkInfo.title + ""; - }); - } - }; -}; \ No newline at end of file diff --git a/scripts/docs/links-package/services/getLinkInfo.js b/scripts/docs/links-package/services/getLinkInfo.js deleted file mode 100644 index 787ff0433..000000000 --- a/scripts/docs/links-package/services/getLinkInfo.js +++ /dev/null @@ -1,72 +0,0 @@ -var _ = require('lodash'); -var path = require('canonical-path'); - -/** - * @dgService getLinkInfo - * @description - * Get link information to a document that matches the given url - * @kind function - * @param {String} url The url to match - * @param {String} title An optional title to return in the link information - * @return {Object} The link information - * - * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc - */ -module.exports = function getLinkInfo(getDocFromAlias, encodeCodeBlock, log) { - - return function getLinkInfoImpl(url, title, currentDoc) { - var linkInfo = { - url: url, - type: 'url', - valid: true, - title: title || url - }; - - if ( !url ) { - throw new Error('Invalid url'); - } - - var docs = getDocFromAlias(url, currentDoc); - - if ( !getLinkInfoImpl.useFirstAmbiguousLink && docs.length > 1 ) { - - linkInfo.valid = false; - linkInfo.errorType = 'ambiguous'; - linkInfo.error = 'Ambiguous link: "' + url + '".\n' + - docs.reduce(function(msg, doc) { return msg + '\n "' + doc.id + '" ('+ doc.docType + ') : (' + doc.path + ' / ' + doc.fileInfo.relativePath + ')'; }, 'Matching docs: '); - - } else if ( docs.length >= 1 ) { - - linkInfo.url = docs[0].path; - linkInfo.title = title || encodeCodeBlock(docs[0].name, true); - linkInfo.type = 'doc'; - - if ( getLinkInfoImpl.relativeLinks && currentDoc && currentDoc.path ) { - var currentFolder = path.dirname(currentDoc.path); - var docFolder = path.dirname(linkInfo.url); - var relativeFolder = path.relative(path.join('/', currentFolder), path.join('/', docFolder)); - linkInfo.url = path.join(relativeFolder, path.basename(linkInfo.url)); - log.debug(currentDoc.path, docs[0].path, linkInfo.url); - } - - } else if ( url.indexOf('#') > 0 ) { - var pathAndHash = url.split('#'); - linkInfo = getLinkInfoImpl(pathAndHash[0], title, currentDoc); - linkInfo.url = linkInfo.url + '#' + pathAndHash[1]; - return linkInfo; - - } else if ( url.indexOf('/') === -1 && url.indexOf('#') !== 0 ) { - - linkInfo.valid = false; - linkInfo.errorType = 'missing'; - linkInfo.error = 'Invalid link (does not match any doc): "' + url + '"'; - - } else { - - linkInfo.title = title || (( url.indexOf('#') === 0 ) ? url.substring(1) : path.basename(url, '.html')); - - } - - return linkInfo; - }; -}; \ No newline at end of file diff --git a/scripts/docs/processors/hide-private-api.js b/scripts/docs/processors/hide-private-api.js index 15e2b6eb2..bd475a46a 100644 --- a/scripts/docs/processors/hide-private-api.js +++ b/scripts/docs/processors/hide-private-api.js @@ -5,14 +5,14 @@ module.exports = function removePrivateApi() { $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/remove-private-members.js b/scripts/docs/processors/remove-private-members.js index 59946a9d8..36fdd3303 100644 --- a/scripts/docs/processors/remove-private-members.js +++ b/scripts/docs/processors/remove-private-members.js @@ -6,16 +6,19 @@ module.exports = function removePrivateMembers() { $runBefore: ['rendering-docs'], $process: function(docs) { docs.forEach(function(doc) { + if (doc.members) { doc.members = doc.members.filter(function(member) { - return !member.tags.tagsByName.get('private'); + return !member.tags.tagsByName.get('hidden'); }); } + if (doc.statics) { doc.statics = doc.statics.filter(function(staticMethod) { - return !staticMethod.tags.tagsByName.get('private'); + return !staticMethod.tags.tagsByName.get('hidden'); }); } + }); return docs; diff --git a/scripts/docs/tag-defs/tag-defs.js b/scripts/docs/tag-defs/tag-defs.js index 5f01bfa2b..98a043ac8 100644 --- a/scripts/docs/tag-defs/tag-defs.js +++ b/scripts/docs/tag-defs/tag-defs.js @@ -6,6 +6,7 @@ module.exports = [ return typeof value !== 'undefined'; }}, {'name': 'usage'}, + {'name': 'hidden'}, // hide from docs {'name': 'classes'}, // related classes {'name': 'interfaces'} // related interfaces ]; diff --git a/scripts/docs/typescript-definition-package/index.js b/scripts/docs/typescript-definition-package/index.js deleted file mode 100644 index ce77a83c9..000000000 --- a/scripts/docs/typescript-definition-package/index.js +++ /dev/null @@ -1,100 +0,0 @@ -var Package = require('dgeni').Package; -var jsdocPackage = require('dgeni-packages/jsdoc'); -var nunjucksPackage = require('dgeni-packages/nunjucks'); -var typescriptPackage = require('../typescript-package'); -var gitPackage = require('dgeni-packages/git'); -var path = require('canonical-path'); - -// Define the dgeni package for generating the docs -module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, gitPackage]) - -// Register the processors -.processor(require('./processors/createTypeDefinitionFile')) - -.config(function(readFilesProcessor, inlineTagProcessor) { - readFilesProcessor.basePath = path.resolve(__dirname, '../..'); - // Don't run unwanted processors - readFilesProcessor.$enabled = false; - inlineTagProcessor.$enabled = false; -}) - - -// Configure the log service -.config(function(log) { - log.level = 'info'; -}) - - -// .config(function(renderDocsProcessor, versionInfo) { -// renderDocsProcessor.extraData.versionInfo = versionInfo; -// }) - -.config(function(readFilesProcessor, inlineTagProcessor, readTypeScriptModules, createTypeDefinitionFile) { - - // Don't run unwanted processors - readFilesProcessor.$enabled = false; // We are not using the normal file reading processor - inlineTagProcessor.$enabled = false; // We are not actually processing the inline link tags - - // Configure file reading - readFilesProcessor.basePath = path.resolve(__dirname, '../..'); - readTypeScriptModules.sourceFiles = [ - 'angular2/angular2.ts', - 'angular2/router.ts' - ]; - readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../modules')); - - createTypeDefinitionFile.typeDefinitions = [ - { - id: 'angular2/angular2', - modules: { - 'angular2/angular2': 'angular2/angular2', - } - }, - { - id: 'angular2/router', - modules: { - 'angular2/router': 'angular2/router' - } - } - ]; -}) - - -.config(function(parseTagsProcessor, getInjectables) { - // We actually don't want to parse param docs in this package as we are getting the data out using TS - parseTagsProcessor.tagDefinitions.forEach(function(tagDef) { - if (tagDef.name === 'param') { - tagDef.docProperty = 'paramData'; - tagDef.transforms = []; - } - }); - -}) - - -// Configure file writing -.config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = 'dist/docs'; -}) - - -// Configure rendering -.config(function(templateFinder, templateEngine) { - - // Nunjucks and Angular conflict in their template bindings so change Nunjucks - templateEngine.config.tags = { - variableStart: '{$', - variableEnd: '$}' - }; - - templateFinder.templateFolders - .unshift(path.resolve(__dirname, 'templates')); - - templateFinder.templatePatterns = [ - '${ doc.template }', - '${ doc.id }.${ doc.docType }.template.html', - '${ doc.id }.template.html', - '${ doc.docType }.template.html', - 'common.template.html' - ]; -}); diff --git a/scripts/docs/typescript-definition-package/mocks/mockPackage.js b/scripts/docs/typescript-definition-package/mocks/mockPackage.js deleted file mode 100644 index 692309100..000000000 --- a/scripts/docs/typescript-definition-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-definition-package/processors/createTypeDefinitionFile.js b/scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.js deleted file mode 100644 index f3bc002ca..000000000 --- a/scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.js +++ /dev/null @@ -1,86 +0,0 @@ -var _ = require('lodash'); -var path = require('canonical-path'); - -module.exports = function createTypeDefinitionFile(log) { - - return { - $runAfter: ['processing-docs'], - $runBefore: ['docs-processed'], - $validate: { - dtsPath: { presence: true }, - dtsExtension: { presence: true }, - typeDefinitions: { presence: true } - }, - dtsPath: 'typings', - dtsExtension: '.d.ts', - typeDefinitions: [], - $process: function(docs) { - var dtsPath = this.dtsPath; - var dtsExtension = this.dtsExtension; - - // For each type definition that we wish to create we define a dgeni "doc" for it - var typeDefDocs = _.map(this.typeDefinitions, function(def) { - - var id = def.id + dtsExtension; - var docPath = path.join(dtsPath, id); - - return { - docType: 'type-definition', - id: id, - aliases: [id], - path: docPath, - outputPath: docPath, - // A type definition may include a number of top level modules - // And those modules could be aliased (such as 'angular2/angular2.api' -> 'angular2/angular2') - moduleDocs: _.transform(def.modules, function(moduleDocs, id, alias) { - moduleDocs[id] = { id: alias, doc: null }; - }) - }; - }); - - // Now add all the module docs to their corresponding type definition doc - _.forEach(docs, function(doc) { - _.forEach(typeDefDocs, function(typeDefDoc) { - if(typeDefDoc.moduleDocs[doc.id]) { - // Add a copy, because we are going to modify it - typeDefDoc.moduleDocs[doc.id].doc = doc; - } - }); - }); - - return _.filter(typeDefDocs, function(doc) { - _.forEach(doc.moduleDocs, function(modDoc, alias) { - if (!doc || !modDoc.doc) { - log.error('createTypeDefinitionFile processor: no such module "' + alias + '" (Did you forget to add it to the modules to load?)'); - doc = null; - return; - } - _.forEach(modDoc.doc.exports, function(exportDoc) { - - // Search for classes with a constructor marked as `@private` - if (exportDoc.docType === 'class' && exportDoc.constructorDoc && exportDoc.constructorDoc.private) { - - // 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'); - } - - // Add the `declare var SomeClass extends InjectableReference` construct - modDoc.doc.exports.push({ - docType: 'var', - name: exportDoc.name, - id: exportDoc.id, - heritage: ': InjectableReference' - }); - } - }); - }); - return !!doc; - }); - } - }; -}; diff --git a/scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js b/scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js deleted file mode 100644 index 1bf15092d..000000000 --- a/scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js +++ /dev/null @@ -1,48 +0,0 @@ -var mockPackage = require('../mocks/mockPackage'); -var Dgeni = require('dgeni'); -var path = require('canonical-path'); -var _ = require('lodash'); - -describe('createTypeDefinitionFile processor', function() { - var dgeni, injector, processor; - - beforeEach(function() { - dgeni = new Dgeni([mockPackage()]); - injector = dgeni.configureInjector(); - processor = injector.get('createTypeDefinitionFile'); - - // Initialize the processor - processor.typeDefinitions = [{ - id: 'angular2/angular2', - modules: { 'angular2/angular2': 'angular2/angular2' } - }]; - }); - - - - describe('classes with private constructors', function() { - - it('should convert heritage from `implements` into `extends`', function() { - - // Create some mock docs for testing - var docs = [ - { - id: 'angular2/angular2', - exports: [ - { docType: 'class', heritage: 'implements Xyz', constructorDoc: { private: true } } - ] - } - ]; - - docs = processor.$process(docs); - - expect(docs.length).toEqual(1); - expect(docs[0].docType).toEqual('type-definition'); - - var moduleDoc = docs[0].moduleDocs['angular2/angular2'].doc; - expect(moduleDoc.exports.length).toEqual(2); - expect(moduleDoc.exports[0].heritage).toEqual('extends Xyz'); - }); - }); - -}); \ No newline at end of file diff --git a/scripts/docs/typescript-definition-package/templates/angular2/angular2.d.ts.template.html b/scripts/docs/typescript-definition-package/templates/angular2/angular2.d.ts.template.html deleted file mode 100644 index ce9778bfd..000000000 --- a/scripts/docs/typescript-definition-package/templates/angular2/angular2.d.ts.template.html +++ /dev/null @@ -1,17 +0,0 @@ -{% extends '../type-definition.template.html' %} -{% block staticDeclarations %} - -interface List extends Array {} -interface Map {} -interface StringMap extends Map {} - -declare module ng { - // See https://github.com/Microsoft/TypeScript/issues/1168 - class BaseException /* extends Error */ { - message: string; - stack: string; - toString(): string; - } - interface InjectableReference {} -} -{% endblock %} diff --git a/scripts/docs/typescript-definition-package/templates/type-definition.template.html b/scripts/docs/typescript-definition-package/templates/type-definition.template.html deleted file mode 100644 index d37344087..000000000 --- a/scripts/docs/typescript-definition-package/templates/type-definition.template.html +++ /dev/null @@ -1,71 +0,0 @@ - -{%- macro commentBlock(doc, level) -%} -{%- if doc.content | trim %} - -{% if level > 1 %}{$ '/**' | indent(level-1, true) | replace(r/\n$/, "") $}{% else %}/**{% endif %} -{$ doc.content | trim | replace(r/^/gm, "* ") | indent(level, true) | replace(r/\n$/, "") $} -{$ '*/' | indent(level, true) | replace(r/\n$/, "") $}{% endif -%} -{%- endmacro -%} - - -{%- macro memberInfo(member) -%} -{$ commentBlock(member, 5) $} - {$ member.name $}{% if member.optional %}?{% endif -%} -{% if member.typeParameters %}<{% for typeParam in member.typeParameters %}{$ typeParam $}{% if not loop.last %}, {% endif %}{% endfor %}>{% endif -%} -{%- if member.parameters -%}({% for param in member.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif -%} -{%- if member.returnType == 'Directive' %}: DirectiveAnnotation{%- elif member.returnType -%}: {$ member.returnType $}{%- else -%}: void -{%- endif -%}; -{%- endmacro -%} - - -// Project: http://angular.io/ -// Definitions by: angular team -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -// *********************************************************** -// This file is generated by the Angular build process. -// Please do not create manual edits or send pull requests -// modifying this file. -// *********************************************************** -{% block staticDeclarations %}{% endblock %} -{% for alias, module in doc.moduleDocs %} -{$ commentBlock(module.doc, 1) $} -declare module ng { - - {%- for export in module.doc.exports -%} - {%- if export.content -%} - {$ commentBlock(export, 3) $} - {%- endif %} - {$ export.docType $} {$ export.name $}{$ export.typeParams $}{%- if export.heritage == ' extends Directive' %} extends DirectiveAnnotation{% else %}{$ export.heritage $}{% endif %} - {%- if export.docType == 'class' or export.docType == 'interface' %} { - {%- if export.newMember %} - {$ memberInfo(export.newMember) $} - {% endif %} - {%- if export.callMember %} - {$ memberInfo(export.callMember) $} - {% endif -%} - {%- for member in export.members %} - {$ memberInfo(member) $} - {%- endfor %} - } - - {%- elif export.docType == 'enum' %} { - {%- for member in export.members %} - {$ member $}{% if not loop.last %}, - {%- endif -%} - {%- endfor %} - } - - {%- else -%} - {% if export.parameters %}({% for param in export.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif %} - {%- if export.returnType %} : {$ export.returnType $} {% endif -%} - ; - {%- endif %} - {% endfor %} -} - -{% endfor %} - -declare module "angular2/angular2" { - export = ng; -} diff --git a/scripts/docs/typescript-package/index.js b/scripts/docs/typescript-package/index.js deleted file mode 100755 index 876c08085..000000000 --- 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 834d53c95..000000000 --- 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 476d4cc44..000000000 --- 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 a2d4be4fe..000000000 --- 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 2020ec7fa..000000000 --- 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 d4c6ef610..000000000 --- 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 0fbae4ad2..000000000 --- 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 74a115e5f..000000000 --- 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 7b6d3f18d..000000000 --- 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 aa80c7a15..000000000 --- a/scripts/docs/typescript-package/processors/readTypeScriptModules.js +++ /dev/null @@ -1,454 +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); - 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 69afdea89..000000000 --- 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 bc4ed7411..000000000 --- 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 760139022..000000000 --- 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 c9d3d368b..000000000 --- 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 { return; } - // deprecated - // @Cordova() - // createEventInNamedCalendar( - // title?: string, - // location?: string, - // notes?: string, - // startDate?: Date, - // endDate?: Date, - // calendarName?: string - // ) {} - /** * Find an event. * diff --git a/src/@ionic-native/plugins/camera/index.ts b/src/@ionic-native/plugins/camera/index.ts index df61ac95d..ede3de60d 100644 --- a/src/@ionic-native/plugins/camera/index.ts +++ b/src/@ionic-native/plugins/camera/index.ts @@ -124,8 +124,7 @@ export interface CameraPopoverOptions { export class Camera { /** - * @private - * @enum {number} + * Constant for possible destination types */ static DestinationType = { /** Return base64 encoded string. DATA_URL can be very memory intensive and cause app crashes or out of memory errors. Use FILE_URI or NATIVE_URI if possible */ @@ -136,19 +135,15 @@ export class Camera { NATIVE_URI: 2 }; - /** - * @private - * @enum {number} - */ static EncodingType = { /** Return JPEG encoded image */ JPEG: 0, /** Return PNG encoded image */ PNG: 1 }; + /** - * @private - * @enum {number} + * @hidden */ static MediaType = { /** Allow selection of still pictures only. DEFAULT. Will return format specified via DestinationType */ @@ -159,10 +154,6 @@ export class Camera { ALLMEDIA: 2 }; - /** - * @private - * @enum {number} - */ static PictureSourceType = { /** Choose image from picture library (same as SAVEDPHOTOALBUM for Android) */ PHOTOLIBRARY: 0, @@ -172,11 +163,6 @@ export class Camera { SAVEDPHOTOALBUM: 2 }; - /** - * @private - * Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover. - * @enum {number} - */ static PopoverArrowDirection = { ARROW_UP: 1, ARROW_DOWN: 2, @@ -185,10 +171,6 @@ export class Camera { ARROW_ANY: 15 }; - /** - * @private - * @enum {number} - */ static Direction = { /** Use the back-facing camera */ BACK: 0, diff --git a/src/@ionic-native/plugins/contacts/index.ts b/src/@ionic-native/plugins/contacts/index.ts index 5cde81c2c..eace0af62 100644 --- a/src/@ionic-native/plugins/contacts/index.ts +++ b/src/@ionic-native/plugins/contacts/index.ts @@ -6,9 +6,6 @@ declare var window: any, export type ContactFieldType = '*' | 'addresses' | 'birthday' | 'categories' | 'country' | 'department' | 'displayName' | 'emails' | 'familyName' | 'formatted' | 'givenName' | 'honorificPrefix' | 'honorificSuffix' | 'id' | 'ims' | 'locality' | 'middleName' | 'name' | 'nickname' | 'note' | 'organizations' | 'phoneNumbers' | 'photos' | 'postalCode' | 'region' | 'streetAddress' | 'title' | 'urls'; -/** - * @private - */ export interface IContactProperties { /** A globally unique identifier. */ @@ -55,7 +52,7 @@ export interface IContactProperties { } /** - * @private + * @hidden */ export class Contact implements IContactProperties { private _objectInstance: any; @@ -101,7 +98,7 @@ export class Contact implements IContactProperties { } /** - * @private + * @hidden */ export interface IContactError { /** Error code */ @@ -111,7 +108,7 @@ export interface IContactError { } /** - * @private + * @hidden */ export declare var ContactError: { new (code: number): IContactError; @@ -140,7 +137,7 @@ export interface IContactName { } /** - * @private + * @hidden */ export class ContactName implements IContactName { constructor(public formatted?: string, @@ -161,7 +158,7 @@ export interface IContactField { } /** - * @private + * @hidden */ export class ContactField implements IContactField { constructor(public type?: string, @@ -189,7 +186,7 @@ export interface IContactAddress { } /** - * @private + * @hidden */ export class ContactAddress implements IContactAddress { constructor(public pref?: boolean, @@ -216,7 +213,7 @@ export interface IContactOrganization { } /** - * @private + * @hidden */ export class ContactOrganization implements IContactOrganization { constructor( @@ -243,7 +240,7 @@ export interface IContactFindOptions { } /** - * @private + * @hidden */ export class ContactFindOptions implements IContactFindOptions { constructor(public filter?: string, @@ -274,6 +271,8 @@ export class ContactFindOptions implements IContactFindOptions { * ); * * ``` + * @classes + * Contact * @interfaces * IContactProperties * IContactError @@ -327,7 +326,7 @@ export class Contacts { } /** - * @private + * @hidden */ function processContact(contact) { let newContact = new Contact(); diff --git a/src/@ionic-native/plugins/date-picker/index.ts b/src/@ionic-native/plugins/date-picker/index.ts index a749c077f..3b03a5b02 100644 --- a/src/@ionic-native/plugins/date-picker/index.ts +++ b/src/@ionic-native/plugins/date-picker/index.ts @@ -156,7 +156,7 @@ export interface DatePickerOptions { export class DatePicker { /** - * @private + * @hidden */ static ANDROID_THEMES = { THEME_TRADITIONAL: 1, diff --git a/src/@ionic-native/plugins/db-meter/index.ts b/src/@ionic-native/plugins/db-meter/index.ts index ba9750608..0e96b58aa 100644 --- a/src/@ionic-native/plugins/db-meter/index.ts +++ b/src/@ionic-native/plugins/db-meter/index.ts @@ -56,7 +56,7 @@ export class DBMeter { /** * Stops listening - * @private + * @hidden */ @Cordova() stop(): Promise { return; } diff --git a/src/@ionic-native/plugins/file/index.ts b/src/@ionic-native/plugins/file/index.ts index 8524cdad3..cbcbd4fdf 100644 --- a/src/@ionic-native/plugins/file/index.ts +++ b/src/@ionic-native/plugins/file/index.ts @@ -776,7 +776,7 @@ export class File { /** Write content to FileEntry. * - * @private + * @hidden * @param {FileEntry} fe file entry object * @param {string | Blob} text content or blob to write * @param {WriteOptions} options replace file if set to true. See WriteOptions for more information. @@ -1042,7 +1042,7 @@ export class File { } /** - * @private + * @hidden */ private fillErrorMessage(err: FileError): void { try { @@ -1138,7 +1138,7 @@ export class File { } /** - * @private + * @hidden */ private remove(fe: Entry): Promise { return new Promise((resolve, reject) => { @@ -1152,7 +1152,7 @@ export class File { } /** - * @private + * @hidden */ private move(srce: Entry, destdir: DirectoryEntry, newName: string): Promise { return new Promise((resolve, reject) => { @@ -1166,7 +1166,7 @@ export class File { } /** - * @private + * @hidden */ private copy(srce: Entry, destdir: DirectoryEntry, newName: string): Promise { return new Promise((resolve, reject) => { @@ -1180,7 +1180,7 @@ export class File { } /** - * @private + * @hidden */ private readEntries(dr: DirectoryReader): Promise { return new Promise((resolve, reject) => { @@ -1194,7 +1194,7 @@ export class File { } /** - * @private + * @hidden */ private rimraf(de: DirectoryEntry): Promise { return new Promise((resolve, reject) => { @@ -1208,7 +1208,7 @@ export class File { } /** - * @private + * @hidden */ private createWriter(fe: FileEntry): Promise { return new Promise((resolve, reject) => { @@ -1222,7 +1222,7 @@ export class File { } /** - * @private + * @hidden */ private write(writer: FileWriter, gu: string | Blob | ArrayBuffer): Promise { if (gu instanceof Blob) { @@ -1242,7 +1242,7 @@ export class File { } /** - * @private + * @hidden */ private writeFileInChunks(writer: FileWriter, file: Blob) { const BLOCK_SIZE = 1024 * 1024; diff --git a/src/@ionic-native/plugins/google-maps/index.ts b/src/@ionic-native/plugins/google-maps/index.ts index dd3daf7d7..a5835f7da 100644 --- a/src/@ionic-native/plugins/google-maps/index.ts +++ b/src/@ionic-native/plugins/google-maps/index.ts @@ -6,7 +6,7 @@ import 'rxjs/add/observable/fromEvent'; declare var plugin: any; /** - * @private + * @hidden * You can listen to these events where appropriate */ export const GoogleMapsEvent = { @@ -31,7 +31,7 @@ export const GoogleMapsEvent = { }; /** - * @private + * @hidden */ export const GoogleMapsAnimation = { BOUNCE: 'BOUNCE', @@ -39,7 +39,7 @@ export const GoogleMapsAnimation = { }; /** - * @private + * @hidden */ export const GoogleMapsMapTypeId = { HYBRID: 'MAP_TYPE_HYBRID', @@ -51,7 +51,7 @@ export const GoogleMapsMapTypeId = { }; /** - * @private + * @hidden */ @Plugin({ pluginName: 'GoogleMaps', @@ -480,7 +480,7 @@ export class GoogleMaps { } /** - * @private + * @hidden */ export interface AnimateCameraOptions { target?: LatLng | Array | LatLngBounds; @@ -491,7 +491,7 @@ export interface AnimateCameraOptions { } /** - * @private + * @hidden */ export interface CameraPosition { target?: LatLng | LatLngBounds | LatLng[]; @@ -501,7 +501,7 @@ export interface CameraPosition { } /** - * @private + * @hidden */ export interface MyLocation { latLng?: LatLng; @@ -511,14 +511,14 @@ export interface MyLocation { } /** - * @private + * @hidden */ export interface MyLocationOptions { enableHighAccuracy?: boolean; } /** - * @private + * @hidden */ export interface VisibleRegion { northeast?: any; @@ -526,7 +526,7 @@ export interface VisibleRegion { } /** - * @private + * @hidden */ export interface MarkerOptions { /** @@ -606,7 +606,7 @@ export interface MarkerOptions { } /** - * @private + * @hidden */ export interface MarkerIcon { url?: string; @@ -617,7 +617,7 @@ export interface MarkerIcon { } /** - * @private + * @hidden */ export class Marker { @@ -879,7 +879,7 @@ export class Marker { } /** - * @private + * @hidden */ export interface CircleOptions { center?: LatLng; @@ -892,7 +892,7 @@ export interface CircleOptions { } /** - * @private + * @hidden */ export class Circle { @@ -1021,7 +1021,7 @@ export class Circle { } /** - * @private + * @hidden */ export interface PolylineOptions { points?: Array; @@ -1033,7 +1033,7 @@ export interface PolylineOptions { } /** - * @private + * @hidden */ export class Polyline { @@ -1159,7 +1159,7 @@ export class Polyline { } /** - * @private + * @hidden */ export interface PolygonOptions { points?: Array; @@ -1173,7 +1173,7 @@ export interface PolygonOptions { } /** - * @private + * @hidden */ export class Polygon { @@ -1305,7 +1305,7 @@ export class Polygon { } /** - * @private + * @hidden */ export interface TileOverlayOptions { tileUrlFormat?: string; @@ -1316,7 +1316,7 @@ export interface TileOverlayOptions { } /** - * @private + * @hidden */ export class TileOverlay { @@ -1433,7 +1433,7 @@ export class TileOverlay { } /** - * @private + * @hidden */ export interface GroundOverlayOptions { url?: string; @@ -1445,7 +1445,7 @@ export interface GroundOverlayOptions { } /** - * @private + * @hidden */ export class GroundOverlay { @@ -1556,7 +1556,7 @@ export class GroundOverlay { } /** - * @private + * @hidden */ export interface KmlOverlayOptions { url?: string; @@ -1565,7 +1565,7 @@ export interface KmlOverlayOptions { } /** - * @private + * @hidden */ export class KmlOverlay { @@ -1657,7 +1657,7 @@ export class KmlOverlay { } /** - * @private + * @hidden */ export class LatLngBounds { private _objectInstance: any; @@ -1688,7 +1688,7 @@ export class LatLngBounds { } /** - * @private + * @hidden */ export class LatLng { @@ -1716,7 +1716,7 @@ export class LatLng { } } /** - * @private + * @hidden */ export interface GeocoderRequest { address?: string; @@ -1724,7 +1724,7 @@ export interface GeocoderRequest { position?: { lat: number; lng: number }; } /** - * @private + * @hidden */ export interface GeocoderResult { adminArea?: string; @@ -1747,7 +1747,7 @@ export interface GeocoderResult { thoroughfare?: string; } /** - * @private + * @hidden */ @Plugin({ pluginName: 'Geocoder', diff --git a/src/@ionic-native/plugins/gyroscope/index.ts b/src/@ionic-native/plugins/gyroscope/index.ts index b8cefa780..605d25ef2 100644 --- a/src/@ionic-native/plugins/gyroscope/index.ts +++ b/src/@ionic-native/plugins/gyroscope/index.ts @@ -5,7 +5,7 @@ import { Injectable } from '@angular/core'; declare var navigator: any; /** - * @private + * @hidden */ export interface GyroscopeOrientation { /** @@ -30,7 +30,7 @@ export interface GyroscopeOrientation { } /** - * @private + * @hidden */ export interface GyroscopeOptions { /** diff --git a/src/@ionic-native/plugins/health/index.ts b/src/@ionic-native/plugins/health/index.ts index 82ae736ec..fb618876f 100644 --- a/src/@ionic-native/plugins/health/index.ts +++ b/src/@ionic-native/plugins/health/index.ts @@ -2,7 +2,7 @@ import { Plugin, Cordova } from '@ionic-native/core'; import { Injectable } from '@angular/core'; /** - * @private + * @hidden */ export interface HealthQueryOptions { /** @@ -38,7 +38,7 @@ export interface HealthQueryOptions { } /** - * @private + * @hidden */ export interface HealthQueryOptionsAggregated { /** @@ -64,7 +64,7 @@ export interface HealthQueryOptionsAggregated { } /** - * @private + * @hidden */ export interface HealthStoreOptions { /** @@ -102,7 +102,7 @@ export interface HealthStoreOptions { } /** - * @private + * @hidden */ export interface HealthData { /** diff --git a/src/@ionic-native/plugins/in-app-browser/index.ts b/src/@ionic-native/plugins/in-app-browser/index.ts index 33cdfc2d0..75270b45b 100644 --- a/src/@ionic-native/plugins/in-app-browser/index.ts +++ b/src/@ionic-native/plugins/in-app-browser/index.ts @@ -61,7 +61,7 @@ export interface InAppBrowserEvent extends Event { } /** - * @private + * @hidden */ export class InAppBrowserObject { diff --git a/src/@ionic-native/plugins/media/index.ts b/src/@ionic-native/plugins/media/index.ts index d468a9918..21fa85793 100644 --- a/src/@ionic-native/plugins/media/index.ts +++ b/src/@ionic-native/plugins/media/index.ts @@ -9,47 +9,47 @@ export interface MediaError { } /** - * @private + * @hidden */ export class MediaObject { // Constants /** - * @private + * @hidden */ static MEDIA_NONE: number = 0; /** - * @private + * @hidden */ static MEDIA_STARTING: number = 1; /** - * @private + * @hidden */ static MEDIA_RUNNING: number = 2; /** - * @private + * @hidden */ static MEDIA_PAUSED: number = 3; /** - * @private + * @hidden */ static MEDIA_STOPPED: number = 4; // error codes /** - * @private + * @hidden */ static MEDIA_ERR_ABORTED: number = 1; /** - * @private + * @hidden */ static MEDIA_ERR_NETWORK: number = 2; /** - * @private + * @hidden */ static MEDIA_ERR_DECODE: number = 3; /** - * @private + * @hidden */ static MEDIA_ERR_NONE_SUPPORTED: number = 4; diff --git a/src/@ionic-native/plugins/mixpanel/index.ts b/src/@ionic-native/plugins/mixpanel/index.ts index de4589102..71896d344 100644 --- a/src/@ionic-native/plugins/mixpanel/index.ts +++ b/src/@ionic-native/plugins/mixpanel/index.ts @@ -114,16 +114,16 @@ export class Mixpanel { } /** - * @private + * @hidden */ @Injectable() export class MixpanelPeople { /** - * @private + * @hidden */ static plugin: string = 'cordova-plugin-mixpanel'; /** - * @private + * @hidden */ static pluginRef: string = 'mixpanel.people'; diff --git a/src/@ionic-native/plugins/nfc/index.ts b/src/@ionic-native/plugins/nfc/index.ts index fd7535f71..b20f141dd 100644 --- a/src/@ionic-native/plugins/nfc/index.ts +++ b/src/@ionic-native/plugins/nfc/index.ts @@ -182,7 +182,7 @@ export class NFC { } /** - * @private + * @hidden */ @Injectable() @Plugin({ diff --git a/src/@ionic-native/plugins/pay-pal/index.ts b/src/@ionic-native/plugins/pay-pal/index.ts index bc25c2c18..0a244fca9 100644 --- a/src/@ionic-native/plugins/pay-pal/index.ts +++ b/src/@ionic-native/plugins/pay-pal/index.ts @@ -150,7 +150,7 @@ export interface PayPalEnvironment { } /** - * @private + * @hidden */ export class PayPalPayment { constructor(amount: string, currency: string, shortDescription: string, intent: string, details?: PayPalPaymentDetails) { @@ -214,7 +214,7 @@ export class PayPalPayment { } /** - * @private + * @hidden */ export class PayPalItem { /** @@ -257,7 +257,7 @@ export class PayPalItem { } /** - * @private + * @hidden */ export class PayPalPaymentDetails { /** @@ -286,7 +286,7 @@ export class PayPalPaymentDetails { } /** - * @private + * @hidden */ export interface PayPalConfigurationOptions { /** @@ -384,7 +384,7 @@ export interface PayPalConfigurationOptions { sandboxUserPin?: string; } /** - * @private + * @hidden */ export class PayPalConfiguration implements PayPalConfigurationOptions { /** @@ -424,7 +424,7 @@ export class PayPalConfiguration implements PayPalConfigurationOptions { } /** - * @private + * @hidden */ export class PayPalShippingAddress { /** diff --git a/src/@ionic-native/plugins/photo-library/index.ts b/src/@ionic-native/plugins/photo-library/index.ts index 793206a7b..9bd605978 100644 --- a/src/@ionic-native/plugins/photo-library/index.ts +++ b/src/@ionic-native/plugins/photo-library/index.ts @@ -157,7 +157,7 @@ export class PhotoLibrary { } /** - * @private + * @hidden */ export interface LibraryItem { /** @@ -182,7 +182,7 @@ export interface LibraryItem { } /** - * @private + * @hidden */ export interface AlbumItem { /** @@ -193,7 +193,7 @@ export interface AlbumItem { } /** - * @private + * @hidden */ export interface GetLibraryOptions { thumbnailWidth?: number; @@ -206,7 +206,7 @@ export interface GetLibraryOptions { } /** - * @private + * @hidden */ export interface RequestAuthorizationOptions { read?: boolean; @@ -214,7 +214,7 @@ export interface RequestAuthorizationOptions { } /** - * @private + * @hidden */ export interface GetThumbnailOptions { thumbnailWidth?: number; diff --git a/src/@ionic-native/plugins/push/index.ts b/src/@ionic-native/plugins/push/index.ts index 0eb94d43e..cba37b291 100644 --- a/src/@ionic-native/plugins/push/index.ts +++ b/src/@ionic-native/plugins/push/index.ts @@ -265,7 +265,7 @@ export class Push { } /** - * @private + * @hidden */ export class PushObject { diff --git a/src/@ionic-native/plugins/secure-storage/index.ts b/src/@ionic-native/plugins/secure-storage/index.ts index 7cc99ff8c..a60e5d634 100644 --- a/src/@ionic-native/plugins/secure-storage/index.ts +++ b/src/@ionic-native/plugins/secure-storage/index.ts @@ -4,7 +4,7 @@ import { CordovaInstance, Plugin, CordovaCheck } from '@ionic-native/core'; declare var cordova: any; /** - * @private + * @hidden */ export class SecureStorageObject { diff --git a/src/@ionic-native/plugins/sqlite/index.ts b/src/@ionic-native/plugins/sqlite/index.ts index bde9b4e22..ec49da5b2 100644 --- a/src/@ionic-native/plugins/sqlite/index.ts +++ b/src/@ionic-native/plugins/sqlite/index.ts @@ -5,7 +5,7 @@ import { Cordova, CordovaInstance, Plugin, CordovaCheck, InstanceProperty } from declare var sqlitePlugin; /** - * @private + * @hidden */ export class SQLiteObject { diff --git a/src/@ionic-native/plugins/themeable-browser/index.ts b/src/@ionic-native/plugins/themeable-browser/index.ts index ea610fefa..89ae4eacb 100644 --- a/src/@ionic-native/plugins/themeable-browser/index.ts +++ b/src/@ionic-native/plugins/themeable-browser/index.ts @@ -68,7 +68,7 @@ export interface ThemeableBrowserOptions { } /** - * @private + * @hidden */ export class ThemeableBrowserObject {