change @internal to @docs-private

Author: jelbourn

src/lib/core/animation/animation.ts

@@ -1,4 +1,4 @@
-/** @internal */
+/** @docs-private */
 export class AnimationCurves {
   static STANDARD_CURVE = 'cubic-bezier(0.4,0.0,0.2,1)';
   static DECELERATION_CURVE = 'cubic-bezier(0.0,0.0,0.2,1)';
@@ -7,7 +7,7 @@ export class AnimationCurves {
 }
 
 
-/** @internal */
+/** @docs-private */
 export class AnimationDurations {
   static COMPLEX = '375ms';
   static ENTERING = '225ms';

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

@@ -1,4 +1,4 @@
-/** @internal */
+/** @docs-private */
 export class PromiseCompleter<R> {
   promise: Promise<R>;
   resolve: (value?: R | PromiseLike<R>) => void;

src/lib/core/errors/error.ts

@@ -2,7 +2,7 @@
 
 /**
  * Wrapper around Error that sets the error message.
- * @internal
+ * @docs-private
  */
 export class MdError extends Error {
   constructor(value: string) {

src/lib/core/line/line.ts

@@ -18,7 +18,7 @@ export class MdLine {}
 
 /**
  * Helper that takes a query list of lines and sets the correct class on the host.
- * @internal
+ * @docs-private
  */
 export class MdLineSetter {
   constructor(private _lines: QueryList<MdLine>, private _renderer: Renderer,

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

@@ -66,7 +66,7 @@ export class ConnectedPositionStrategy implements PositionStrategy {
   /**
    * Updates the position of the overlay element, using whichever preferred position relative
    * to the origin fits on-screen.
-   * @internal
+   * @docs-private
    */
   apply(element: HTMLElement): Promise<void> {
     // We need the bounding rects for the origin and the overlay to determine how to position

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

@@ -101,7 +101,7 @@ export class GlobalPositionStrategy implements PositionStrategy {
 
   /**
    * Apply the position to the element.
-   * @internal
+   * @docs-private
    */
   apply(element: HTMLElement): Promise<void> {
     if (!this._wrapper) {

src/lib/core/overlay/position/viewport-ruler.ts

@@ -4,7 +4,7 @@ import {Injectable} from '@angular/core';
 
 /**
  * Simple utility for getting the bounds of the browser viewport.
- * @internal
+ * @docs-private
  */
 @Injectable()
 export class ViewportRuler {

src/lib/core/platform/platform.ts

@@ -9,7 +9,7 @@ const hasV8BreakIterator = (window.Intl && (window.Intl as any).v8BreakIterator)
 /**
  * Service to detect the current platform by comparing the userAgent strings and
  * checking browser-specific global properties.
- * @internal
+ * @docs-private
  */
 @Injectable()
 export class MdPlatform {

src/lib/core/portal/portal-errors.ts

@@ -2,7 +2,7 @@ import {MdError} from '../errors/error';
 
 /**
  * Exception thrown when attempting to attach a null portal to a host.
- * @internal
+ * @docs-private
  */
 export class MdNullPortalError extends MdError {
   constructor() {
@@ -12,7 +12,7 @@ export class MdNullPortalError extends MdError {
 
 /**
  * Exception thrown when attempting to attach a portal to a host that is already attached.
- * @internal
+ * @docs-private
  */
 export class MdPortalAlreadyAttachedError extends MdError {
   constructor() {
@@ -22,7 +22,7 @@ export class MdPortalAlreadyAttachedError extends MdError {
 
 /**
  * Exception thrown when attempting to attach a portal to an already-disposed host.
- * @internal
+ * @docs-private
  */
 export class MdPortalHostAlreadyDisposedError extends MdError {
   constructor() {
@@ -32,7 +32,7 @@ export class MdPortalHostAlreadyDisposedError extends MdError {
 
 /**
  * Exception thrown when attempting to attach an unknown portal type.
- * @internal
+ * @docs-private
  */
 export class MdUnknownPortalTypeError extends MdError {
   constructor() {
@@ -44,7 +44,7 @@ export class MdUnknownPortalTypeError extends MdError {
 
 /**
  * Exception thrown when attempting to attach a portal to a null host.
- * @internal
+ * @docs-private
  */
 export class MdNullPortalHostError extends MdError {
   constructor() {
@@ -54,7 +54,7 @@ export class MdNullPortalHostError extends MdError {
 
 /**
  * Exception thrown when attempting to detach a portal that is not attached.
- * @internal
+ * @docs-private
  */
 export class MdNoPortalAttachedError extends MdError {
   constructor() {

src/lib/core/projection/projection.ts

@@ -7,7 +7,7 @@ function _replaceWith(toReplaceEl: HTMLElement, otherEl: HTMLElement) {
   toReplaceEl.parentElement.replaceChild(otherEl, toReplaceEl);
 }
 
-/** @internal */
+/** @docs-private */
 @Directive({
   selector: 'dom-projection-host'
 })
@@ -16,7 +16,7 @@ export class DomProjectionHost {
 }
 
 
-/** @internal */
+/** @docs-private */
 @Injectable()
 export class DomProjection {
   /**
@@ -74,7 +74,7 @@ export class DomProjection {
 }
 
 
-/** @internal */
+/** @docs-private */
 @NgModule({
   exports: [DomProjectionHost],
   declarations: [DomProjectionHost],

src/lib/core/ripple/ripple-renderer.ts

@@ -3,7 +3,7 @@ import {
   NgZone,
 } from '@angular/core';
 
-/** @internal */
+/** @docs-private */
 export enum ForegroundRippleState {
   NEW,
   EXPANDING,
@@ -12,7 +12,7 @@ export enum ForegroundRippleState {
 
 /**
  * Wrapper for a foreground ripple DOM element and its animation state.
- * @internal
+ * @docs-private
  */
 export class ForegroundRipple {
   state = ForegroundRippleState.NEW;
@@ -37,7 +37,7 @@ const distanceToFurthestCorner = (x: number, y: number, rect: ClientRect) => {
  * The constructor takes a reference to the ripple directive's host element and a map of DOM
  * event handlers to be installed on the element that triggers ripple animations.
  * This will eventually become a custom renderer once Angular support exists.
- * @internal
+ * @docs-private
  */
 export class RippleRenderer {
   private _backgroundDiv: HTMLElement;

src/lib/dialog/dialog-container.ts

@@ -16,7 +16,7 @@ import 'rxjs/add/operator/first';
 
 /**
  * Internal component that wraps user-provided dialog content.
- * @internal
+ * @docs-private
  */
 @Component({
   moduleId: module.id,

src/lib/grid-list/grid-list-errors.ts

@@ -2,7 +2,7 @@ import {MdError} from '../core';
 
 /**
  * Exception thrown when cols property is missing from grid-list
- * @internal
+ * @docs-private
  */
 export class MdGridListColsError extends MdError {
   constructor() {
@@ -12,7 +12,7 @@ export class MdGridListColsError extends MdError {
 
 /**
  * Exception thrown when a tile's colspan is longer than the number of cols in list
- * @internal
+ * @docs-private
  */
 export class MdGridTileTooWideError extends MdError {
   constructor(cols: number, listLength: number) {
@@ -22,7 +22,7 @@ export class MdGridTileTooWideError extends MdError {
 
 /**
  * Exception thrown when an invalid ratio is passed in as a rowHeight
- * @internal
+ * @docs-private
  */
 export class MdGridListBadRatioError extends MdError {
   constructor(value: string) {

src/lib/grid-list/grid-list-measure.ts

@@ -1,15 +1,15 @@
 
 /**
  * Converts values into strings. Falsy values become empty strings.
- * @internal
+ * @docs-private
  */
 export function coerceToString(value: string | number): string {
   return `${value || ''}`;
 }
 
 /**
  * Converts a value that might be a string into a number.
- * @internal
+ * @docs-private
  */
 export function coerceToNumber(value: string | number): number {
   return typeof value === 'string' ? parseInt(value, 10) : value;

src/lib/grid-list/tile-coordinator.ts

@@ -16,7 +16,7 @@ import {MdGridTileTooWideError} from './grid-list-errors';
  * decrements each value in the tracking array (indicating that the column is one cell closer to
  * being free).
  *
- * @internal
+ * @docs-private
  */
 export class TileCoordinator {
   /** Tracking array (see class description). */
@@ -138,7 +138,7 @@ export class TileCoordinator {
 
 /**
  * Simple data structure for tile position (row, col).
- * @internal
+ * @docs-private
  */
 export class TilePosition {
   constructor(public row: number, public col: number) {}

src/lib/grid-list/tile-styler.ts

@@ -5,7 +5,7 @@ import {MdGridListBadRatioError} from './grid-list-errors';
 /**
  * Sets the style properties for an individual tile, given the position calculated by the
  * Tile Coordinator.
- * @internal
+ * @docs-private
  */
 export class TileStyler {
   _gutterSize: string;
@@ -120,7 +120,7 @@ export class TileStyler {
 /**
  * This type of styler is instantiated when the user passes in a fixed row height.
  * Example <md-grid-list cols="3" rowHeight="100px">
- * @internal
+ * @docs-private
  */
 export class FixedTileStyler extends TileStyler {
 
@@ -148,7 +148,7 @@ export class FixedTileStyler extends TileStyler {
 /**
  * This type of styler is instantiated when the user passes in a width:height ratio
  * for the row height.  Example <md-grid-list cols="3" rowHeight="3:1">
- * @internal
+ * @docs-private
  */
 export class RatioTileStyler extends TileStyler {
 
@@ -195,7 +195,7 @@ export class RatioTileStyler extends TileStyler {
  * In other words, the row height will reflect the total height of the container divided
  * by the number of rows.  Example <md-grid-list cols="3" rowHeight="fit">
  *
- * @internal
+ * @docs-private
  */
 export class FitTileStyler extends TileStyler {
 

src/lib/icon/icon-registry.ts

@@ -14,7 +14,7 @@ import 'rxjs/add/operator/catch';
 
 /**
  * Exception thrown when attempting to load an icon with a name that cannot be found.
- * @internal
+ * @docs-private
  */
 export class MdIconNameNotFoundError extends MdError {
   constructor(iconName: string) {
@@ -25,7 +25,7 @@ export class MdIconNameNotFoundError extends MdError {
 /**
  * Exception thrown when attempting to load SVG content that does not contain the expected
  * <svg> tag.
- * @internal
+ * @docs-private
  */
 export class MdIconSvgTagNotFoundError extends MdError {
   constructor() {
@@ -35,7 +35,7 @@ export class MdIconSvgTagNotFoundError extends MdError {
 
 /**
  * Configuration for an icon, including the URL and possibly the cached SVG element.
- * @internal
+ * @docs-private
  */
 class SvgIconConfig {
   svgElement: SVGElement = null;

src/lib/menu/menu-errors.ts

@@ -2,7 +2,7 @@ import {MdError} from '../core';
 
 /**
  * Exception thrown when menu trigger doesn't have a valid md-menu instance
- * @internal
+ * @docs-private
  */
 export class MdMenuMissingError extends MdError {
   constructor() {
@@ -18,7 +18,7 @@ export class MdMenuMissingError extends MdError {
 /**
  * Exception thrown when menu's x-position value isn't valid.
  * In other words, it doesn't match 'before' or 'after'.
- * @internal
+ * @docs-private
  */
 export class MdMenuInvalidPositionX extends MdError {
   constructor() {
@@ -31,7 +31,7 @@ export class MdMenuInvalidPositionX extends MdError {
 /**
  * Exception thrown when menu's y-position value isn't valid.
  * In other words, it doesn't match 'above' or 'below'.
- * @internal
+ * @docs-private
  */
 export class MdMenuInvalidPositionY extends MdError {
   constructor() {

src/lib/progress-circle/progress-circle.ts

@@ -72,11 +72,11 @@ export class MdProgressCircle implements OnDestroy {
     return this.mode == 'determinate' ? 100 : null;
   }
 
-  /** @internal */
+  /** @docs-private */
   get interdeterminateInterval() {
     return this._interdeterminateInterval;
   }
-  /** @internal */
+  /** @docs-private */
   set interdeterminateInterval(interval: number) {
     clearInterval(this._interdeterminateInterval);
     this._interdeterminateInterval = interval;

src/lib/slider/slider.ts

@@ -490,7 +490,7 @@ export class MdSlider implements ControlValueAccessor {
 
 /**
  * Renderer class in order to keep all dom manipulation in one place and outside of the main class.
- * @internal
+ * @docs-private
  */
 export class SliderRenderer {
   private _sliderElement: HTMLElement;