chore(docs): rename @Private to @internal

The latter is understood by TypeScript's --stripInternal option, so this lets us
rely more on the tooling provided by typescript team.

Author: alexeagle

docs/typescript-definition-package/processors/code_gen.js

@@ -49,7 +49,7 @@ DtsSerializer.prototype = {
   },
 
   member: function(buffer, ast) {
-    if (ast.private) return;
+    if (ast.private || ast.internal) return;
 
     buffer.push('\n');
     this.comment(buffer, ast.content);

docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js

@@ -25,22 +25,22 @@ describe('createTypeDefinitionFile processor', function() {
 
 
 
-  describe('classes with private constructors', function() {
-    
+  describe('classes with @internal 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 }  }
+            { docType: 'class', heritage: 'implements Xyz', constructorDoc: { internal: true }  }
           ]
         }
       ];
 
       docs = processor.$process(docs);
-      
+
       expect(docs.length).toEqual(1);
       expect(docs[0].docType).toEqual('type-definition');
 
@@ -49,5 +49,5 @@ describe('createTypeDefinitionFile processor', function() {
       expect(moduleDoc.exports[0].heritage).toEqual('extends Xyz');
     });
   });
-	
+
 });

docs/typescript-package/index.js

@@ -1,9 +1,10 @@
 var basePackage = require('dgeni-packages/base');
+var jsdocPackage = require('dgeni-packages/jsdoc');
 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])
+module.exports = new Package('typescript-parsing', [basePackage, jsdocPackage])
 
 // Register the services and file readers
 .factory(require('./services/modules'))
@@ -37,6 +38,9 @@ module.exports = new Package('typescript-parsing', [basePackage])
   log.level = 'warn';
 })
 
+.config(function(parseTagsProcessor) {
+  parseTagsProcessor.tagDefinitions.push({ name: 'internal', transforms: function() { return true; } });
+})
 
 // Configure ids and paths
 .config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {

docs/typescript-package/services/convertPrivateClassesToInterfaces.js

@@ -4,8 +4,8 @@ module.exports = function convertPrivateClassesToInterfaces() {
   return function(exportDocs, addInjectableReference) {
     _.forEach(exportDocs, function(exportDoc) {
 
-      // Search for classes with a constructor marked as `@private`
-      if (exportDoc.docType === 'class' && exportDoc.constructorDoc && exportDoc.constructorDoc.private) {
+      // 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';

docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js

@@ -11,21 +11,21 @@ describe('readTypeScriptModules', function() {
     convertPrivateClassesToInterfaces = injector.get('convertPrivateClassesToInterfaces');
   });
 
-  it('should convert private class docs to interface docs', function() {
+  it('should convert @internal class docs to interface docs', function() {
     var docs = [
       {
         docType: 'class',
         name: 'privateClass',
         id: 'privateClass',
-        constructorDoc: { private: true }
+        constructorDoc: { internal: true }
       }
     ];
     convertPrivateClassesToInterfaces(docs, false);
     expect(docs[0].docType).toEqual('interface');
   });
 
 
-  it('should not touch non-private class docs', function() {
+  it('should not touch non-internal class docs', function() {
     var docs = [
       {
         docType: 'class',
@@ -45,7 +45,7 @@ describe('readTypeScriptModules', function() {
         docType: 'class',
         name: 'privateClass',
         id: 'privateClass',
-        constructorDoc: { private: true },
+        constructorDoc: { internal: true },
         heritage: 'implements parentInterface'
       }
     ];
@@ -60,7 +60,7 @@ describe('readTypeScriptModules', function() {
         docType: 'class',
         name: 'privateClass',
         id: 'privateClass',
-        constructorDoc: { private: true },
+        constructorDoc: { internal: true },
         heritage: 'implements parentInterface'
       }
     ];

modules/angular2/src/core/application_ref.ts

@@ -113,7 +113,7 @@ export function createNgZone(): NgZone {
 var _platform: PlatformRef;
 
 /**
- * @private
+ * @internal
  */
 export function platformCommon(bindings?: Array<Type | Binding | any[]>, initializer?: () => void):
     PlatformRef {
@@ -145,12 +145,12 @@ export function platformCommon(bindings?: Array<Type | Binding | any[]>, initial
  */
 export class PlatformRef {
   /**
-   * @private
+   * @internal
    */
   _applications: ApplicationRef[] = [];
 
   /**
-   * @private
+   * @internal
    */
   constructor(private _injector: Injector, private _dispose: () => void) {}
 
@@ -251,7 +251,7 @@ export class PlatformRef {
   }
 
   /**
-   * @private
+   * @internal
    */
   _applicationDisposed(app: ApplicationRef): void { ListWrapper.remove(this._applications, app); }
 }
@@ -266,7 +266,7 @@ export class ApplicationRef {
   private _rootComponents: ComponentRef[] = [];
 
   /**
-   * @private
+   * @internal
    */
   constructor(private _platform: PlatformRef, private _zone: NgZone, private _injector: Injector) {}
 

modules/angular2/src/core/application_tokens.ts

@@ -2,7 +2,7 @@ import {OpaqueToken, Binding} from 'angular2/src/core/di';
 import {CONST_EXPR, Math, StringWrapper} from 'angular2/src/core/facade/lang';
 
 /**
- *  @private
+ *  @internal
  */
 export const APP_COMPONENT_REF_PROMISE = CONST_EXPR(new OpaqueToken('Promise<ComponentRef>'));
 

modules/angular2/src/core/change_detection/change_detector_ref.ts

@@ -6,7 +6,7 @@ import {ChangeDetectionStrategy} from './constants';
  */
 export class ChangeDetectorRef {
   /**
-   * @private
+   * @internal
    */
   constructor(private _cd: ChangeDetector) {}
 

modules/angular2/src/core/change_detection/parser/locals.ts

@@ -3,7 +3,7 @@ import {BaseException} from 'angular2/src/core/facade/exceptions';
 import {ListWrapper, MapWrapper} from 'angular2/src/core/facade/collection';
 
 /**
- * @private
+ * @internal
  */
 export class Locals {
   constructor(public parent: Locals, public current: Map<any, any>) {}

modules/angular2/src/core/compiler/runtime_compiler.ts

@@ -10,7 +10,7 @@ import {Promise, PromiseWrapper} from 'angular2/src/core/facade/async';
 @Injectable()
 export class RuntimeCompiler extends Compiler {
   /**
-   * @private
+   * @internal
    */
   constructor(_protoViewFactory: ProtoViewFactory, private _templateCompiler: TemplateCompiler) {
     super(_protoViewFactory);