Add module names for the typedoc, make it work

Mark members with @private for typedoc.
This commit is contained in:
Panayot Cankov
2017-04-19 13:39:17 +03:00
parent c59077161f
commit d098ff43f5
101 changed files with 647 additions and 186 deletions

View File

@@ -1,4 +1,8 @@
import { LayoutBase, View, Property, Length } from "../layout-base";
/**
* @module "ui/layouts/absolute-layout"
*/ /** */
import { LayoutBase, View, Property, Length } from "../layout-base";
/**
* A layout that lets you specify exact locations (left/top coordinates) of its children.

View File

@@ -1,4 +1,8 @@
import { LayoutBase, View, Property } from "../layout-base";
/**
* @module "ui/layouts/dock-layout"
*/ /** */
import { LayoutBase, View, Property } from "../layout-base";
/**
* A Layout that arranges its children at its outer edges, and allows its last child to take up the remaining space.

View File

@@ -1,3 +1,7 @@
/**
* @module "ui/layouts/flexbox-layout"
*/ /** */
import { LayoutBase, View, Style, CssProperty } from "../layout-base";
export type FlexDirection = "row" | "row-reverse" | "column" | "column-reverse";

View File

@@ -1,4 +1,8 @@
import { LayoutBase, Property, View } from "../layout-base";
/**
* @module "ui/layouts/grid-layout"
*/ /** */
import { LayoutBase, Property, View } from "../layout-base";
/**
* Defines row/column specific properties that apply to GridLayout elements.
@@ -128,9 +132,21 @@ export class GridLayout extends LayoutBase {
public getRows(): Array<ItemSpec>;
//@private
/**
* @private
*/
public _onRowAdded(itemSpec: ItemSpec): void;
/**
* @private
*/
public _onColumnAdded(itemSpec: ItemSpec): void;
/**
* @private
*/
public _onRowRemoved(itemSpec: ItemSpec, index: number): void;
/**
* @private
*/
public _onColumnRemoved(itemSpec: ItemSpec, index: number): void;
//@endprivate
}

View File

@@ -1,4 +1,8 @@
import { View, CustomLayoutView, Property, Length } from "../core/view";
/**
* @module "ui/layouts/layout-base"
*/ /** */
import { View, CustomLayoutView, Property, Length } from "../core/view";
export * from "../core/view";

View File

@@ -1,4 +1,8 @@
import { LayoutBase } from "./layout-base";
/**
* @module "ui/layouts/layout"
*/ /** */
import { LayoutBase } from "./layout-base";
/**
* Base class for all views that supports children positioning in cross platform manner.

View File

@@ -1,4 +1,7 @@
import { LayoutBase, Property } from "../layout-base";
/**
* @module "ui/layouts/stack-layout"
*/ /** */
import { LayoutBase, Property } from "../layout-base";
/**
* A Layout that arranges its children horizontally or vertically. The direction can be set by orientation property.

View File

@@ -1,4 +1,8 @@
import { LayoutBase, Property, Length } from "../layout-base";
/**
* @module "ui/layouts/wrap-layout"
*/ /** */
import { LayoutBase, Property, Length } from "../layout-base";
/**
* WrapLayout position children in rows or columns depending on orientation property