chore(doc-gen): remove unnecessary @public and @exportedAs tags

This commit is contained in:
Peter Bacon Darwin
2015-07-11 07:21:46 +01:00
parent 9fa7d38133
commit 2e4a2a0e5a
83 changed files with 5 additions and 299 deletions
+2 -2
View File
@@ -134,10 +134,10 @@ You can selectively build either the JS or Dart versions as follows:
* `$(npm bin)/gulp build.js`
* `$(npm bin)/gulp build.dart`
Also note that in order for the whole test suite to succeed you will need to generate the docs by running:
Also note that in order for the whole test suite to succeed you will need to generate the type definitions by running:
```shell
$(npm bin)/gulp docs
$(npm bin)/gulp docs/typings
```
To clean out the `dist` folder, run:
-2
View File
@@ -48,9 +48,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage,
.config(function(parseTagsProcessor, getInjectables) {
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/public'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/private'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/exportedAs'));
// 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) {
-4
View File
@@ -1,4 +0,0 @@
module.exports = {
name: 'exportedAs',
multi: true
};
-4
View File
@@ -1,4 +0,0 @@
module.exports = {
name: 'public',
transforms: function(doc, tag) { return true; }
};
@@ -46,9 +46,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage,
.config(function(parseTagsProcessor, getInjectables) {
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/public'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/private'));
parseTagsProcessor.tagDefinitions.push(require('./tag-defs/exportedAs'));
// 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) {
@@ -1,4 +0,0 @@
module.exports = {
name: 'exportedAs',
multi: true
};
@@ -1,4 +0,0 @@
module.exports = {
name: 'public',
transforms: function(doc, tag) { return true; }
};
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
*
* Annotations provide the additional information that Angular requires in order to run your
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Change detection enables data binding in Angular.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Define angular core API here.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* The `di` module provides dependency injection container services.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Errors thrown by the {@link Injector}.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Metadata which control how the dependencies are resolved by the {@link Injector}.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Common directives shipped with Angular.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module is used for handling user input, by defining and building a {@link ControlGroup} that
* consists of
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* The http module provides services to perform http requests. To get started, see the {@link Http}
* class.
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module provides advanced support for extending change detection.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* This module provides advanced support for extending dom strategy.
*/
-1
View File
@@ -1,6 +1,5 @@
/**
* @module
* @public
* @description
* Maps application URLs into application states, to support deep-linking and navigation.
*/
@@ -21,24 +21,18 @@ import {CONST, CONST_EXPR, isPresent, BaseException} from 'angular2/src/facade/l
/**
* Structural diffing for `Object`s and `Map`s.
*
* @exportedAs angular2/pipes
*/
export const keyValDiff: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new KeyValueChangesFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Structural diffing for `Iterable` types such as `Array`s.
*
* @exportedAs angular2/pipes
*/
export const iterableDiff: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new IterableChangesFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Async binding to such types as Observable.
*
* @exportedAs angular2/pipes
*/
export const async: List<PipeFactory> = CONST_EXPR([
CONST_EXPR(new ObservablePipeFactory()),
@@ -48,64 +42,48 @@ export const async: List<PipeFactory> = CONST_EXPR([
/**
* Uppercase text transform.
*
* @exportedAs angular2/pipes
*/
export const uppercase: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new UpperCaseFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Lowercase text transform.
*
* @exportedAs angular2/pipes
*/
export const lowercase: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new LowerCaseFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Json stringify transform.
*
* @exportedAs angular2/pipes
*/
export const json: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new JsonPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* LimitTo text transform.
*
* @exportedAs angular2/pipes
*/
export const limitTo: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new LimitToPipeFactory()), CONST_EXPR(new NullPipeFactory())]);
/**
* Number number transform.
*
* @exportedAs angular2/pipes
*/
export const decimal: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new DecimalPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Percent number transform.
*
* @exportedAs angular2/pipes
*/
export const percent: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new PercentPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Currency number transform.
*
* @exportedAs angular2/pipes
*/
export const currency: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new CurrencyPipe()), CONST_EXPR(new NullPipeFactory())]);
/**
* Date/time formatter.
*
* @exportedAs angular2/pipes
*/
export const date: List<PipeFactory> =
CONST_EXPR([CONST_EXPR(new DatePipe()), CONST_EXPR(new NullPipeFactory())]);
@@ -138,8 +116,6 @@ export const PROTO_CHANGE_DETECTOR_KEY = CONST_EXPR(new OpaqueToken('ProtoChange
/**
* Implements change detection using a map of pregenerated proto detectors.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
export class PreGeneratedChangeDetection extends ChangeDetection {
@@ -171,8 +147,6 @@ export class PreGeneratedChangeDetection extends ChangeDetection {
* Implements change detection that does not require `eval()`.
*
* This is slower than {@link JitChangeDetection}.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
export class DynamicChangeDetection extends ChangeDetection {
@@ -186,8 +160,6 @@ export class DynamicChangeDetection extends ChangeDetection {
*
* This requires `eval()`. For change detection that does not require `eval()`, see
* {@link DynamicChangeDetection} and {@link PreGeneratedChangeDetection}.
*
* @exportedAs angular2/change_detection
*/
@Injectable()
@CONST()
@@ -7,8 +7,6 @@ import {CHECK_ONCE, DETACHED, CHECK_ALWAYS} from './constants';
* {@link ChangeDetectorRef} allows requesting checks for detectors that rely on observables. It
*also allows detaching and
* attaching change detector subtrees.
*
* @exportedAs angular2/change_detection
*/
export class ChangeDetectorRef {
constructor(private _cd: ChangeDetector) {}
@@ -28,7 +28,6 @@ import {DirectiveRecord} from './directive_record';
* ```javascript
* bootstrap(MyApp, [bind(ChangeDetection).toClass(DynamicChangeDetection)]);
* ```
* @exportedAs angular2/change_detection
*/
@CONST()
export class ChangeDetection {
@@ -68,8 +68,6 @@ var defaultLocale: string = 'en-US';
* {{ dateObj | date:'medium' }} // output is 'Jun 15, 2015, 9:43:11 PM'
* {{ dateObj | date:'shortTime' }} // output is '9:43 PM'
* {{ dateObj | date:'mmss' }} // output is '43:11'
*
* @exportedAs angular2/pipes
*/
@CONST()
export class DatePipe extends BasePipe implements PipeFactory {
@@ -25,9 +25,6 @@ export class IterableChangesFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new IterableChanges(); }
}
/**
* @exportedAs angular2/pipes
*/
export class IterableChanges extends BasePipe {
private _collection = null;
private _length: int = null;
@@ -475,9 +472,6 @@ export class IterableChanges extends BasePipe {
}
}
/**
* @exportedAs angular2/pipes
*/
export class CollectionChangeRecord {
currentIndex: int = null;
previousIndex: int = null;
@@ -24,8 +24,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
@CONST()
export class JsonPipe extends BasePipe implements PipeFactory {
@@ -3,9 +3,6 @@ import {stringify, looseIdentical, isJsObject, CONST} from 'angular2/src/facade/
import {ChangeDetectorRef} from '../change_detector_ref';
import {WrappedValue, BasePipe, Pipe, PipeFactory} from './pipe';
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class KeyValueChangesFactory implements PipeFactory {
supports(obj): boolean { return KeyValueChanges.supportsObj(obj); }
@@ -13,9 +10,6 @@ export class KeyValueChangesFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new KeyValueChanges(); }
}
/**
* @exportedAs angular2/pipes
*/
export class KeyValueChanges extends BasePipe {
private _records: Map<any, any> = new Map();
private _mapHead: KVChangeRecord = null;
@@ -327,10 +321,6 @@ export class KeyValueChanges extends BasePipe {
}
/**
* @exportedAs angular2/pipes
*/
export class KVChangeRecord {
previousValue: any = null;
currentValue: any = null;
@@ -49,8 +49,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* {{ 'abcdefghij' | limitTo: 4 }} // output is 'abcd'
* {{ 'abcdefghij' | limitTo: -4 }} // output is 'ghij'
* {{ 'abcdefghij' | limitTo: -100 }} // output is 'abcdefghij'
*
* @exportedAs angular2/pipes
*/
export class LimitToPipe implements Pipe {
static supportsObj(obj): boolean { return isString(obj) || isArray(obj); }
@@ -76,9 +74,6 @@ export class LimitToPipe implements Pipe {
onDestroy(): void {}
}
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class LimitToPipeFactory implements PipeFactory {
supports(obj): boolean { return LimitToPipe.supportsObj(obj); }
@@ -21,8 +21,6 @@ import {ChangeDetectorRef} from '../change_detector_ref';
* }
*
* ```
*
* @exportedAs angular2/pipes
*/
export class LowerCasePipe implements Pipe {
_latestValue: string = null;
@@ -41,9 +39,6 @@ export class LowerCasePipe implements Pipe {
}
}
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class LowerCaseFactory implements PipeFactory {
supports(str): boolean { return isString(str); }
@@ -2,9 +2,6 @@ import {isBlank, CONST} from 'angular2/src/facade/lang';
import {Pipe, BasePipe, WrappedValue, PipeFactory} from './pipe';
import {ChangeDetectorRef} from '../change_detector_ref';
/**
* @exportedAs angular2/pipes
*/
@CONST()
export class NullPipeFactory implements PipeFactory {
supports(obj): boolean { return NullPipe.supportsObj(obj); }
@@ -12,9 +9,6 @@ export class NullPipeFactory implements PipeFactory {
create(cdRef: ChangeDetectorRef): Pipe { return new NullPipe(); }
}
/**
* @exportedAs angular2/pipes
*/
export class NullPipe extends BasePipe {
called: boolean = false;
@@ -75,8 +75,6 @@ export class NumberPipe extends BasePipe implements PipeFactory {
* {{ 123 | number }} // output is 123
* {{ 123.1 | number: '.2-3' }} // output is 123.10
* {{ 1 | number: '2.2' }} // output is 01.00
*
* @exportedAs angular2/pipes
*/
@CONST()
export class DecimalPipe extends NumberPipe {
@@ -94,8 +92,6 @@ export class DecimalPipe extends NumberPipe {
* expression | percent[:digitInfo]
*
* For more information about `digitInfo` see {@link DecimalPipe}
*
* @exportedAs angular2/pipes
*/
@CONST()
export class PercentPipe extends NumberPipe {
@@ -117,8 +113,6 @@ export class PercentPipe extends NumberPipe {
* symbol (e.g. $) or the currency code (e.g. USD) in the output. The default for this value
* is `false`.
* For more information about `digitInfo` see {@link DecimalPipe}
*
* @exportedAs angular2/pipes
*/
@CONST()
export class CurrencyPipe extends NumberPipe {

Some files were not shown because too many files have changed in this diff Show More