Skip to content

Commit 473752b

Browse files
authored
chore: mark non-public APIs as @internal (#2100)
* chore: mark non-public APIs as @internal * change @internal to @docs-private
1 parent 8f1c5a9 commit 473752b

37 files changed

+117
-165
lines changed

src/demo-app/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"outDir": "../../dist/",
1313
"sourceMap": true,
1414
"target": "es5",
15-
"stripInternal": true,
15+
"stripInternal": false,
1616
"baseUrl": "",
1717
"typeRoots": [
1818
"../../node_modules/@types"

src/e2e-app/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"outDir": "../../dist/",
1313
"sourceMap": true,
1414
"target": "es5",
15-
"stripInternal": true,
15+
"stripInternal": false,
1616
"baseUrl": "",
1717
"typeRoots": [
1818
"../../node_modules/@types",

src/lib/button-toggle/button-toggle.ts

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor
9797
@ContentChildren(forwardRef(() => MdButtonToggle))
9898
_buttonToggles: QueryList<MdButtonToggle> = null;
9999

100-
/** TODO: internal */
101100
ngAfterViewInit() {
102101
this._isInitialized = true;
103102
}
@@ -199,26 +198,17 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor
199198
this._change.emit(event);
200199
}
201200

202-
/**
203-
* Implemented as part of ControlValueAccessor.
204-
* TODO: internal
205-
*/
201+
/** Implemented as part of ControlValueAccessor. */
206202
writeValue(value: any) {
207203
this.value = value;
208204
}
209205

210-
/**
211-
* Implemented as part of ControlValueAccessor.
212-
* TODO: internal
213-
*/
206+
/** Implemented as part of ControlValueAccessor. */
214207
registerOnChange(fn: (value: any) => void) {
215208
this._controlValueAccessorChangeFn = fn;
216209
}
217210

218-
/**
219-
* Implemented as part of ControlValueAccessor.
220-
* TODO: internal
221-
*/
211+
/** Implemented as part of ControlValueAccessor. */
222212
registerOnTouched(fn: any) {
223213
this.onTouched = fn;
224214
}
@@ -423,9 +413,7 @@ export class MdButtonToggle implements OnInit {
423413
this._emitChangeEvent();
424414
}
425415

426-
/** TODO: internal */
427416
_onInputClick(event: Event) {
428-
429417
// We have to stop propagation for click events on the visual hidden input element.
430418
// By default, when a user clicks on a label element, a generated click event will be
431419
// dispatched on the associated input element. Since we are using a label element as our

src/lib/checkbox/checkbox.ts

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -231,33 +231,22 @@ export class MdCheckbox implements ControlValueAccessor {
231231
return this.disableRipple || this.disabled;
232232
}
233233

234-
/**
235-
* Implemented as part of ControlValueAccessor.
236-
* TODO: internal
237-
*/
234+
/** Implemented as part of ControlValueAccessor. */
238235
writeValue(value: any) {
239236
this.checked = !!value;
240237
}
241238

242-
/**
243-
* Implemented as part of ControlValueAccessor.
244-
* TODO: internal
245-
*/
239+
/** Implemented as part of ControlValueAccessor. */
246240
registerOnChange(fn: (value: any) => void) {
247241
this._controlValueAccessorChangeFn = fn;
248242
}
249243

250-
/**
251-
* Implemented as part of ControlValueAccessor.
252-
* TODO: internal
253-
*/
244+
/** Implemented as part of ControlValueAccessor. */
254245
registerOnTouched(fn: any) {
255246
this.onTouched = fn;
256247
}
257248

258-
/**
259-
* Implemented as a part of ControlValueAccessor.
260-
*/
249+
/** Implemented as a part of ControlValueAccessor. */
261250
setDisabledState(isDisabled: boolean) {
262251
this.disabled = isDisabled;
263252
}

src/lib/core/animation/animation.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1+
/** @docs-private */
12
export class AnimationCurves {
23
static STANDARD_CURVE = 'cubic-bezier(0.4,0.0,0.2,1)';
34
static DECELERATION_CURVE = 'cubic-bezier(0.0,0.0,0.2,1)';
45
static ACCELERATION_CURVE = 'cubic-bezier(0.4,0.0,1,1)';
56
static SHARP_CURVE = 'cubic-bezier(0.4,0.0,0.6,1)';
6-
};
7+
}
78

89

10+
/** @docs-private */
911
export class AnimationDurations {
10-
static COMPLEX = '375ms';
11-
static ENTERING = '225ms';
12-
static EXITING = '195ms';
13-
};
12+
static COMPLEX = '375ms';
13+
static ENTERING = '225ms';
14+
static EXITING = '195ms';
15+
}

src/lib/core/async/promise-completer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
/** @docs-private */
22
export class PromiseCompleter<R> {
33
promise: Promise<R>;
44
resolve: (value?: R | PromiseLike<R>) => void;

src/lib/core/errors/error.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
/**
44
* Wrapper around Error that sets the error message.
5+
* @docs-private
56
*/
67
export class MdError extends Error {
78
constructor(value: string) {

src/lib/core/line/line.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ import {DefaultStyleCompatibilityModeModule} from '../compatibility/default-mode
1616
@Directive({ selector: '[md-line], [mat-line]' })
1717
export class MdLine {}
1818

19-
/* Helper that takes a query list of lines and sets the correct class on the host */
19+
/**
20+
* Helper that takes a query list of lines and sets the correct class on the host.
21+
* @docs-private
22+
*/
2023
export class MdLineSetter {
2124
constructor(private _lines: QueryList<MdLine>, private _renderer: Renderer,
2225
private _element: ElementRef) {

src/lib/core/overlay/overlay-directives.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,6 @@ export class ConnectedOverlayDirective implements OnDestroy {
160160
return this._dir ? this._dir.value : 'ltr';
161161
}
162162

163-
/** TODO: internal */
164163
ngOnDestroy() {
165164
this._destroyOverlay();
166165
}

src/lib/core/overlay/position/connected-position-strategy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export class ConnectedPositionStrategy implements PositionStrategy {
6666
/**
6767
* Updates the position of the overlay element, using whichever preferred position relative
6868
* to the origin fits on-screen.
69-
* TODO: internal
69+
* @docs-private
7070
*/
7171
apply(element: HTMLElement): Promise<void> {
7272
// We need the bounding rects for the origin and the overlay to determine how to position

0 commit comments

Comments
 (0)