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

@ -23,13 +23,18 @@ module.exports = function(grunt) {
// Custom Functions
var filterTypeScriptFiles = function(content, srcPath) {
var matchRule = /^.*@private/ig;
if (matchRule.test(content))
{
var leadingPrivate = /^.*@private/ig;
if (leadingPrivate.test(content)) {
return false;
}
var blockCommentPrivate = /\/\*\*([^](?!\*\/))*@module([^](?!\*\/))*@private[^]*?\*\//g;
if (blockCommentPrivate.test(content)) {
return false;
}
var processed = content;
processed = processed.replace(/\/\/[\/\s]*@private((.|\s)*?)\/\/[\/\s]*@endprivate/gm, "");
processed = processed.replace(/\/\/[\/\s]*@private[^]*?\/\/[\/\s]*?@endprivate/gm, "");
return processed;
};

View File

@ -28,7 +28,8 @@
"shelljs": "^0.7.0",
"time-grunt": "1.3.0",
"tslint": "^4.4.2",
"typedoc": "https://github.com/hdeshev/typedoc/blob/npm/typedoc-no-types.tgz?raw=true",
"typedoc": "^0.5.10",
"typedoc-plugin-external-module-name": "git+https://github.com/PanayotCankov/typedoc-plugin-external-module-name.git#with-js",
"typescript": "~2.2.1"
},
"scripts": {
@ -56,7 +57,7 @@
"test-watch-android": "npm run pretest && concurrently --kill-others \"npm run tsc-tiw\" \"tns livesync android --path tests --watch\"",
"test-watch-ios": "npm run pretest && concurrently --kill-others \"npm run tsc-tiw\" \"tns livesync ios --path tests --watch\"",
"prepublish": "echo \"Development reminder: npm run setup\n\"",
"typedoc": "typedoc --tsconfig tsconfig.typedoc.json --out bin/dist/apiref --mode file --includeDeclarations --name NativeScript --theme ./node_modules/nativescript-typedoc-theme",
"typedoc": "typedoc --tsconfig tsconfig.typedoc.json --out bin/dist/apiref --includeDeclarations --name NativeScript --theme ./node_modules/nativescript-typedoc-theme --excludeExternals --externalPattern tns-core-modules/module.d.ts tns-core-modules/tns-core-modules.d.ts",
"dev-typedoc": "npm run typedoc && cd bin/dist/apiref && http-server",
"test-tsc-es2016": "npm run tsc -- -p tsconfig.public.es2016.json",
"tslint": "tslint --config build/tslint.json 'tns-core-modules/**/*.ts' 'tests/**/*.ts' 'apps/**/*.ts' -e '**/node_modules/**' -e '**/platforms/**'"

View File

@ -1,6 +1,9 @@
/**
* @module "application-settings"
*
* Allows you to save and restore any kind of information related to your application.
*/
*/ /** */
/**
* Checks whether such a key exists.
* @param key The key to check for.

View File

@ -1,7 +1,10 @@
///<reference path="../tns-core-modules.d.ts" /> Include global typings
/**
/**
* @module "application"
*
* Contains the application abstraction with all related methods.
*/
*/ /** */
///<reference path="../tns-core-modules.d.ts" /> Include global typings
import { NavigationEntry, View, Observable, EventData } from "../ui/frame";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "color"
*
* Allows creating colors to be used when styling the UI.
*/
*/ /** */
/**
* Represents a color object. Stores all color components (alpha (opacity), red, green, blue) in a [0..255] range.
*/

View File

@ -1,4 +1,8 @@
export var AliceBlue;
/**
* @module "color/known-colors"
*/ /** */
export var AliceBlue;
export var AntiqueWhite;
export var Aqua;
export var Aquamarine;

View File

@ -1,6 +1,9 @@
/**
* @module "connectivity"
*
* Contains connectivity utility methods.
*/
*/ /** */
/**
* Gets the type of connection.
* Returns a value from the connectivity.connectionType enumeration.

View File

@ -1,3 +1,7 @@
/**
* @module "css-value"
*/ /** */
interface CSSValue {
type: string;
string: string;

View File

@ -1,3 +1,7 @@
/**
* @module "css"
*/ /** */
export interface Position {
start: { line: number; column: number };
end: { line: number; column: number };

View File

@ -1,8 +1,10 @@
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
/**
/**
* @module "data/observable-array"
*
* Contains the ObservableArray class, which is capable of detecting and responding to changes of a collection of objects.
*/
*/ /** */
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
import * as observable from "../observable";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "data/observable"
*
* Contains the Observable class, which represents an observable object, or "data" in the model-view paradigm.
*/
*/ /** */
/**
* Base event data.
*/
@ -144,8 +147,13 @@ export class Observable {
//@private
/**
* This method is intended to be overriden by inheritors to provide additional implementation.
* @private
*/
_createPropertyChangeData(name: string, value: any, oldValue?: any): PropertyChangeData;
/**
* @private
*/
_emit(eventNames: string);
//@endprivate
}

View File

@ -1,6 +1,9 @@
/**
* @module "data/virtual-array"
*
* Contains the VirtualArray class, which is an advanced array like class that helps loading items on demand.
*/
*/ /** */
import * as observable from "../observable";
import * as observableArray from "../observable-array";

View File

@ -1,68 +0,0 @@
declare type Promise<T> = any;
declare type Set<T> = any;
declare type Map<K, V> = any;
declare class Request {
constructor(input: string|Request, init?: RequestInit);
method: string;
url: string;
headers: Headers;
context: RequestContext;
referrer: string;
mode: RequestMode;
credentials: RequestCredentials;
cache: RequestCache;
}
interface RequestInit {
method?: string;
headers?: HeaderInit|{ [index: string]: string };
body?: BodyInit;
mode?: RequestMode;
credentials?: RequestCredentials;
cache?: RequestCache;
}
declare class Headers {
append(name: string, value: string): void;
delete(name: string): void;
get(name: string): string;
getAll(name: string): Array<string>;
has(name: string): boolean;
set(name: string, value: string): void;
}
declare class Body {
bodyUsed: boolean;
/*
arrayBuffer(): Promise<ArrayBuffer>;
blob(): Promise<Blob>;
*/
formData(): Promise<FormData>;
json(): Promise<any>;
text(): Promise<string>;
}
declare class Response extends Body {
constructor(body?: BodyInit, init?: ResponseInit);
error(): Response;
redirect(url: string, status: number): Response;
type: ResponseType;
url: string;
status: number;
ok: boolean;
statusText: string;
headers: Headers;
clone(): Response;
}
declare enum ResponseType { "basic", "cors", "default", "error", "opaque" }
declare class ResponseInit {
status: number;
statusText: string;
headers: HeaderInit;
}
declare type BodyInit = Blob|FormData|string;
declare type RequestInfo = Request|string;

View File

@ -1,6 +1,9 @@
/**
* @module "file-system/file-name-resolver"
*
* Provides FileNameResolver class used for loading files based on device capabilities.
*/
*/ /** */
export interface PlatformContext {
width: number;
height: number;

View File

@ -1,4 +1,8 @@
/**
* @module "file-system/file-system-access"
*/ /** */
/**
* An utility class used to provide methods to access and work with the file system.
*/
export class FileSystemAccess {

View File

@ -1,6 +1,8 @@
/**
* @module "file-system"
*
* Provides high-level abstractions for file system entities such as files, folders, known folders, paths, separators, etc.
*/
*/ /** */
/**
* Represents a single entity on the file system.

View File

@ -1,6 +1,8 @@
/**
* @module "fps-meter"
*
* Allows you to capture the frames-per-second metrics of your application.
*/
*/ /** */
/**
* Starts the frames-per-second meter.

View File

@ -1,4 +1,7 @@

/**
* @module "fps-meter/fps-native"
*/ /** */
/**
* An utility class used to measure frames per second.
*/

View File

@ -1,4 +1,9 @@
//@private
/**
* @module "http/http-request"
* @private
*/ /** */
//@private
import * as http from "..";
export var request: (options: http.HttpRequestOptions) => Promise<http.HttpResponse>;

View File

@ -1,6 +1,9 @@
/**
* @module "http"
*
* Allows you to send web requests and receive the responses.
*/
*/ /** */
import * as image from "../image-source";
import * as fs from "../file-system";

View File

@ -1,3 +1,7 @@
/**
* @module "image-asset"
*/ /** */
import { Observable } from "../data/observable";
export class ImageAsset extends Observable {

View File

@ -1,6 +1,9 @@
/**
* @module "image-source"
*
* Contains the ImageSource class, which encapsulates the common abstraction behind a platform specific object (typically a Bitmap) that is used as a source for images.
*/
*/ /** */
import * as imageAssetModule from "../image-asset";
/**
* Encapsulates the common abstraction behind a platform specific object (typically a Bitmap) that is used as a source for images.

View File

@ -1,4 +1,9 @@
//@private
/**
* @module "js-libs/easysax"
* @private
*/ /** */
//@private
export class EasySAXParser {
constructor();
parse(xml: string): void;

View File

@ -1,4 +1,8 @@
/* tslint:disable */
/**
* @module "js-libs/esprima"
*/ /** */
/* tslint:disable */
// Type definitions for Esprima v1.2.0
// Project: http://esprima.org

View File

@ -1,4 +1,9 @@
//@private
/**
* @module "js-libs/polymer-expressions"
* @private
*/ /** */
//@private
export class PolymerExpressions {
static getExpression(expression: string): Expression;
}

View File

@ -1,7 +1,10 @@
/* tslint:disable:class-name */
/**
/**
* @module "platform"
*
* Contains all kinds of information about the device, its operating system and software.
*/
*/ /** */
/* tslint:disable:class-name */
/**
* Gets a value indicating if the app is running on the Android platform.

View File

@ -1,6 +1,9 @@
/**
* @module "text/formatted-string"
*
* Contains the FormattedString and Span classes, which are used to create a formatted (rich text) strings.
*/
*/ /** */
import { Span } from "./span";
import { ObservableArray } from "../data/observable-array";
import { ViewBase } from "../ui/core/view";

View File

@ -1,4 +1,8 @@
import { Color } from "../color";
/**
* @module "text/span"
*/ /** */
import { Color } from "../color";
import { ViewBase } from "../ui/core/view-base";
import { FontStyle, FontWeight } from "../ui/styling/font";
import { TextDecoration } from "../ui/text-base";
@ -48,6 +52,9 @@ export class Span extends ViewBase {
public text: string;
//@private
/**
* @private
*/
_setTextInternal(value: string): void;
//@endprivate
}

View File

@ -1,6 +1,9 @@
/**
* @module "text"
*
* Defines specific text related enumerations.
*/
*/ /** */
/**
* Defines the supported character encodings.
*/

View File

@ -1,6 +1,9 @@
/**
* @module "timer"
*
* Allows you to create, start, stop and react to timers.
*/
*/ /** */
/**
* Calls a function after a specified delay.
* @param callback The function to be called.

View File

@ -1,6 +1,9 @@
/**
* @module "trace"
*
* Allows you to trace and print specific information based on categories.
*/
*/ /** */
/**
* Enables the trace module.
*/

View File

@ -1,6 +1,9 @@
/**
* @module "ui/action-bar"
*
* Contains the action bar related classes.
*/
*/ /** */
import { EventData, ViewBase, View } from "../core/view";
/**
@ -39,6 +42,9 @@ export class ActionBar extends View {
update();
//@private
/**
* @private
*/
_isEmpty(): boolean;
//@endprivate
}
@ -114,6 +120,9 @@ export class ActionItem extends ViewBase {
on(event: "tap", callback: (args: EventData) => void);
//@private
/**
* @private
*/
_raiseTap(): void;
//@endprivate

View File

@ -1,6 +1,9 @@
/**
* @module "ui/activity-indicator"
*
* Contains the ActivityIndicator class, which represents a widget for showing that something is currently busy.
*/
*/ /** */
import { View } from "../core/view";
/**

View File

@ -1,4 +1,8 @@
import { View, Color } from "../core/view";
/**
* @module "ui/animation"
*/ /** */
import { View, Color } from "../core/view";
/**
* Defines animation options for the View.animate method.

View File

@ -1,3 +1,7 @@
/**
* @module "ui/animation/keyframe-animation"
*/ /** */
import { View } from "../core/view";
export interface KeyframeDeclaration {

View File

@ -1,6 +1,9 @@
/**
* @module "ui/animation/keyframe-animation"
*
* Contains the Border class, which represents a UI border component.
*/
*/ /** */
import { ContentView } from "../content-view";
/**

View File

@ -1,4 +1,9 @@
//@private
/**
* @module "ui/builder/binding-builder"
* @private
*/ /** */
//@private
export module bindingConstants {
export var sourceProperty: string;
export var targetProperty: string;
@ -14,4 +19,3 @@ export module bindingConstants {
export function getBindingOptions(name: string, value: string): any;
export var parentsRegex: RegExp;
}

View File

@ -1,4 +1,8 @@
import { View, Template, KeyedTemplate } from "../core/view";
/**
* @module "ui/builder"
*/ /** */
import { View, Template, KeyedTemplate } from "../core/view";
import { Page } from "../page";
export function loadPage(moduleNamePath: string, fileName: string, moduleExports?: any): Page;

View File

@ -1,3 +1,7 @@
/**
* @module "ui/builder/component-builder"
*/ /** */
import { View } from "../../core/view";
export function getComponentModule(elementName: string, namespace: string, attributes: Object, exports: Object, moduleNamePath?: string): ComponentModule;

View File

@ -1,6 +1,9 @@
/**
* @module "ui/button"
*
* Contains the Button class, which represents a standard button widget.
*/
*/ /** */
import { TextBase, EventData } from "../text-base";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/content-view"
*
* View that can host another view.
*/
*/ /** */
import { View, AddChildFromBuilder } from "../core/view";
export * from "../core/view";
@ -18,6 +21,7 @@ export class ContentView extends View implements AddChildFromBuilder {
//@private
/**
* Called when the content property has changed.
* @private
* @param oldView The previous content.
* @param newView The new content.
*/

View File

@ -1,4 +1,8 @@
import { ViewBase } from "../view-base";
/**
* @module "ui/core/bindable"
*/ /** */
import { ViewBase } from "../view-base";
import { Observable, WrappedValue, PropertyChangeData, EventData } from "../../../data/observable";
import { isEnabled as traceEnabled, write as traceWrite, categories as traceCategories, notifyEvent as traceNotifyEvent, messageType as traceMessageType, isCategorySet } from "../../../trace";

View File

@ -1,4 +1,8 @@
/**
* @module "ui/core/control-state-change"
*/ /** */
/**
* An utility class used for supporting styling infrastructure.
*/
export class ControlStateChangeListener {

View File

@ -1,6 +1,9 @@
/**
* @module "ui/core/dependency-observable"
*
* Contains the DependencyObservable class, which represents an extended Observable object that uses Property instances for value backing mechanism.
*/
*/ /** */
import { Observable, EventData } from "../../../data/observable";
/**

View File

@ -1,3 +1,7 @@
/**
* @module "ui/core/properties"
*/ /** */
import { ViewBase } from "../view-base";
import { Style } from "../../styling/style";

View File

@ -1,3 +1,7 @@
/**
* @module "ui/core/view-base"
*/ /** */
import { Property, InheritedProperty, Style } from "../properties";
import { BindingOptions, Observable } from "../bindable";
@ -60,13 +64,37 @@ export abstract class ViewBase extends Observable {
alignSelf: AlignSelf;
//@private
/**
* @private
*/
_oldLeft: number;
/**
* @private
*/
_oldTop: number;
/**
* @private
*/
_oldRight: number;
/**
* @private
*/
_oldBottom: number;
/**
* @private
*/
_defaultPaddingTop: number;
/**
* @private
*/
_defaultPaddingRight: number;
/**
* @private
*/
_defaultPaddingBottom: number;
/**
* @private
*/
_defaultPaddingLeft: number;
//@endprivate

View File

@ -1,3 +1,7 @@
/**
* @module "ui/core/view"
*/ /** */
///<reference path="../../../tns-core-modules.d.ts" /> Include global typings
import { ViewBase, Property, EventData, Color } from "../view-base";
import { Animation, AnimationDefinition, AnimationPromise } from "../../animation";
@ -472,37 +476,65 @@ export abstract class View extends ViewBase implements ApplyXmlAttributes {
public eachChildView(callback: (view: View) => boolean): void;
//@private
/**
* @private
*/
isLayoutRequired: boolean;
/**
* @private
*/
_gestureObservers: any;
/**
* @private
*/
_setNativeClipToBounds(): void;
/**
* @private
*/
_updateLayout(): void;
/**
* Called by measure method to cache measureSpecs.
* @private
*/
_setCurrentMeasureSpecs(widthMeasureSpec: number, heightMeasureSpec: number): boolean;
/**
* Called by layout method to cache view bounds.
* @private
*/
_setCurrentLayoutBounds(left: number, top: number, right: number, bottom: number): void;
/**
* Return view bounds.
* @private
*/
_getCurrentLayoutBounds(): { left: number; top: number; right: number; bottom: number };
/**
* @private
*/
_goToVisualState(state: string);
/**
* @private
*/
_setNativeViewFrame(nativeView: any, frame: any): void;
// _onStylePropertyChanged(property: dependencyObservable.Property): void;
/**
* @private
*/
_updateEffectiveLayoutValues(parent: View): void;
/**
* @private
*/
_currentWidthMeasureSpec: number;
/**
* @private
*/
_currentHeightMeasureSpec: number;
/**
* @private
*/
_setMinWidthNative(value: Length): void;
/**
* @private
*/
_setMinHeightNative(value: Length): void;
//@endprivate
@ -522,8 +554,17 @@ export abstract class View extends ViewBase implements ApplyXmlAttributes {
*/
export class CustomLayoutView extends View {
//@private
/**
* @private
*/
_updateNativeLayoutParams(child: View): void;
/**
* @private
*/
_setChildMinWidthNative(child: View): void;
/**
* @private
*/
_setChildMinHeightNative(child: View): void;
//@endprivate
}

View File

@ -1,3 +1,7 @@
/**
* @module "ui/core/weak-event-listener"
*/ /** */
import { Observable, EventData } from "../../../data/observable";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/date-picker"
*
* Contains the DatePicker class.
*/
*/ /** */
import { View, Property } from "../core/view";
export const yearProperty: Property<DatePicker, number>;

View File

@ -1,6 +1,9 @@
/**
* @module "ui/dialogs"
*
* Allows you to show different dialogs such as alerts, prompts, etc.
*/
*/ /** */
/**
* Defines the input type for prompt dialog.
*/

View File

@ -1,4 +1,8 @@
import { TextBase, Property, CssProperty, Style, Color, FormattedString } from "../text-base";
/**
* @module "ui/editor-text-base"
*/ /** */
import { TextBase, Property, CssProperty, Style, Color, FormattedString } from "../text-base";
/**
* Represents the base class for all editable text views.
@ -60,6 +64,9 @@ export const hintProperty: Property<EditableTextBase, string>;
export const placeholderColorProperty: CssProperty<Style, Color>;
//@private
/**
* @private
*/
export function _updateCharactersInRangeReplacementString(formattedText: FormattedString, rangeLocation: number, rangeLength: number, replacementString: string): void;
//@endprivate

View File

@ -1,5 +1,8 @@

import * as animationModule from "tns-core-modules/ui/animation";
/**
* @module "ui/enums"
*/ /** */
import * as animationModule from "../animation";
/**
* Represents a soft keyboard flavor.

View File

@ -1,6 +1,9 @@
/**
* @module "ui/frame"
*
* Contains the Frame class, which represents the logical View unit that is responsible for navigation within an application.
*/
*/ /** */
import { Page, View, Observable, EventData } from "../page";
import { Transition } from "../transition";
@ -100,10 +103,25 @@ export class Frame extends View {
ios: iOSFrame;
//@private
/**
* @private
*/
navigationQueueIsEmpty(): boolean;
/**
* @private
*/
navigationBarHeight: number;
/**
* @private
*/
_processNavigationQueue(page: Page);
/**
* @private
*/
_updateActionBar(page?: Page, disableNavBarAnimation?: boolean);
/**
* @private
*/
_getNavBarVisible(page: Page): boolean;
//@endprivate
@ -245,9 +263,21 @@ export interface BackstackEntry {
resolvedPage: Page;
//@private
/**
* @private
*/
navDepth: number;
/**
* @private
*/
fragmentTag: string;
/**
* @private
*/
isBack: boolean;
/**
* @private
*/
isNavigation: boolean;
//@endprivate
}
@ -352,13 +382,25 @@ export interface iOSFrame {
navBarVisibility: "auto" | "never" | "always";
//@private
/**
* @private
*/
_disableNavBarAnimation: boolean;
//@endprivate
}
export function setActivityCallbacks(activity: any /*android.app.Activity*/): void;
//@private
/**
* @private
*/
export function reloadPage(): void;
/**
* @private
*/
export function resolvePageFromEntry(entry: NavigationEntry): Page;
/**
* @private
*/
export function setFragmentCallbacks(fragment: any /*android.app.Fragment*/): void;
//@endprivate

View File

@ -1,6 +1,9 @@
/**
* Contains the GesturesObserver class, which lets you observe and respond to user gestures
*/
* @module "ui/gestures"
*
* Contains the GesturesObserver class, which lets you observe and respond to user gestures.
*/ /** */
import { View, EventData } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/html-view"
*
* Contains the HtmlView class, which represents a standard html view widget.
*/
*/ /** */
import { View, Property } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/image-cache"
*
* Contains the Cache class, which handles image download requests and caches the already downloaded images.
*/
*/ /** */
import * as observable from "../../data/observable";
import * as imageSource from "../../image-source";
@ -88,7 +91,13 @@ export class Cache extends observable.Observable {
on(event: "downloaded", callback: (args: DownloadedData) => void , thisArg?: any);
//@private
/**
* @private
*/
_downloadCore(request: DownloadRequest);
/**
* @private
*/
_onDownloadCompleted(key: string, image: any);
//@endprivate
}

View File

@ -1,6 +1,9 @@
/**
* @module "ui/image"
*
* Contains the Image class, which represents an image widget.
*/
*/ /** */
import { View, Property, InheritedCssProperty, Color, Style } from "../core/view";
import { ImageSource } from "../../image-source";

View File

@ -1,6 +1,9 @@
/**
* @module "ui/label"
*
* Contains the Label class, which represents a standard label widget.
*/
*/ /** */
import { TextBase } from "../text-base";
/**

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

View File

@ -1,6 +1,9 @@
/**
* @module "ui/list-picker"
*
* Contains the ListPicker class.
*/
*/ /** */
import { View, Property } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/list-view"
*
* Contains the ListView class, which represents a standard list view widget.
*/
*/ /** */
import { EventData, View, Template, KeyedTemplate, Length, Property, CssProperty, Color, Style } from "../core/view";
/**

View File

@ -1,7 +1,10 @@
///<reference path="../../tns-core-modules.d.ts" /> Include global typings
/**
* Contains the Page class, which represents a logical unit for navigation inside a Frame.
*/
/**
* @module "ui/page"
*
* Contains the Page class, which represents a logical unit for navigation inside a Frame.
*/ /** */
///<reference path="../../tns-core-modules.d.ts" /> Include global typings
import { ContentView, EventData, Property, Color } from "../content-view";
import { Frame } from "../frame";
import { ActionBar } from "../action-bar";
@ -218,12 +221,14 @@ export class Page extends ContentView {
/**
* identifier for the fragment that shows this page.
* Android only.
* Android only.
* @private
*/
public _fragmentTag: string;
/**
* A method called before navigating to the page.
* @private
* @param context - The data passed to the page through the NavigationEntry.context property.
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
* @param bindingContext - An object to become the binding context of the page navigating to. Optional.
@ -232,23 +237,32 @@ export class Page extends ContentView {
/**
* A method called after navigated to the page.
* @private
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
*/
public onNavigatedTo(isBackNavigation: boolean): void;
/**
* A method called before navigating from the page.
* @private
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
*/
public onNavigatingFrom(isBackNavigation: boolean): void;
/**
* A method called after navigated from the page.
* @private
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
*/
public onNavigatedFrom(isBackNavigation: boolean): void;
/**
* @private
*/
_refreshCss(): void;
/**
* @private
*/
_getStyleScope(): styleScope.StyleScope;
//@endprivate
}

View File

@ -1,6 +1,9 @@
/**
* @module "ui/placeholder"
*
* Contains the Placeholder class, which is used to add a native view to the visual tree.
*/
*/ /** */
import { View, EventData } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/progress"
*
* Contains the Progress class, which represents a component capable of showing progress.
*/
*/ /** */
import { View, Property } from "../core/view";
/**

View File

@ -1,3 +1,7 @@
/**
* @module "ui/proxy-view-container"
*/ /** */
import { LayoutBase } from "../layouts/layout-base";
export class ProxyViewContainer extends LayoutBase {

View File

@ -1,6 +1,9 @@
/**
* @module "ui/repeater"
*
* Contains the Repeater class, which represents a UI Repeater component.
*/
*/ /** */
import { LayoutBase, CustomLayoutView, Template, Property } from "../layouts/layout-base";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/scroll-view"
*
* Contains the ScrollView class, which represents a scrollable area that can have content that is larger than its bounds.
*/
*/ /** */
import { ContentView, EventData, Property } from "../content-view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/search-bar"
*
* Contains the SearchBar class, which represents a standard search bar component.
*/
*/ /** */
import { View, Property, EventData, Color } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/segmented-bar"
*
* Contains the SegmentedBar class, which represents a SegmentedBar component.
*/
*/ /** */
import {
ViewBase, View, AddChildFromBuilder, AddArrayFromBuilder,
Property, CoercibleProperty, EventData, Color

View File

@ -1,6 +1,9 @@
/**
* @module "ui/slider"
*
* Contains the Slider class, which represents a standard slider component.
*/
*/ /** */
import { View, Property, CoercibleProperty } from "../core/view";
/**

View File

@ -1,3 +1,7 @@
/**
* @module "ui/styling/background"
*/ /** */
import { ImageSource } from "../../image-source";
import { Color } from "../../color";
import { View, BackgroundRepeat } from "../core/view";

View File

@ -1,3 +1,8 @@
/**
* @module "ui/styling/css-selector-parser"
* @private
*/ /** */
//@private
export interface SimpleSelector {
pos: number;

View File

@ -1,4 +1,8 @@
import * as parser from "../../../css";
/**
* @module "ui/styling/css-selector"
*/ /** */
import * as parser from "../../../css";
/**
* An interface describing the shape of a type on which the selectors may apply.

View File

@ -1,4 +1,8 @@
export class Font {
/**
* @module "ui/styling/font"
*/ /** */
export class Font {
public static default: Font;
public fontFamily: string;

View File

@ -1,3 +1,7 @@
/**
* @module "ui/styling/style-properties"
*/ /** */
import { Color } from "../../color";
import { Style, CssProperty, CssAnimationProperty, ShorthandProperty, InheritedCssProperty } from "../core/properties";
import { Font, FontStyle, FontWeight } from "./font";

View File

@ -1,8 +1,13 @@
//@private
import { ViewBase } from "ui/core/view-base";
import { SyntaxTree } from "css";
import { RuleSet, Node, SelectorCore, ChangeMap } from "ui/styling/css-selector";
import { KeyframeAnimationInfo } from "ui/animation/keyframe-animation";
/**
* @module "ui/styling/style-scope"
* @private
*/ /** */
//@private
import { ViewBase } from "../core/view-base";
import { SyntaxTree } from "../../css";
import { RuleSet, Node, SelectorCore, ChangeMap } from "../styling/css-selector";
import { KeyframeAnimationInfo } from "../animation/keyframe-animation";
export class CssState {
/**

View File

@ -1,3 +1,7 @@
/**
* @module "ui/styling/style"
*/ /** */
import { Length, PercentLength, ViewBase, Observable, BackgroundRepeat, Visibility, HorizontalAlignment, VerticalAlignment} from "../../core/view";
import { Color } from "../../../color";
import { Background } from "../background";
@ -6,7 +10,7 @@ import { TextAlignment, TextDecoration, TextTransform, WhiteSpace } from "../../
import {
FlexDirection, FlexWrap, JustifyContent, AlignItems, AlignContent,
Order, FlexGrow, FlexShrink, FlexWrapBefore, AlignSelf
} from "../../layouts/flexbox-layout"
} from "../../layouts/flexbox-layout";
export interface Thickness {
left: number;

View File

@ -1,6 +1,9 @@
/**
* @module "ui/switch"
*
* Contains the Switch class, which represents a standard switch component.
*/
*/ /** */
import { View, Property } from "../core/view";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/tab-view"
*
* Contains the TabView class, which represents a standard content component with tabs.
*/
*/ /** */
import { View, ViewBase, Property, CssProperty, Style, EventData, Color } from "../core/view";
import { TextTransform } from "../text-base";
/**

View File

@ -1,4 +1,8 @@
import { View, AddChildFromBuilder, Property, CssProperty, InheritedCssProperty, Style, Length } from "../core/view";
/**
* @module "ui/text-base"
*/ /** */
import { View, AddChildFromBuilder, Property, CssProperty, InheritedCssProperty, Style, Length } from "../core/view";
import { FormattedString } from "../../text/formatted-string";
export * from "../core/view";
@ -70,20 +74,25 @@ export class TextBase extends View implements AddChildFromBuilder {
*/
paddingTop: Length;
//@private
/**
* Called for every child element declared in xml.
* This method will add a child element (value) to current element.
* @private
* @param name - Name of the element.
* @param value - Value of the element.
*/
_addChildFromBuilder(name: string, value: any): void;
/**
* @private
* Called when the text property is changed to request layout.
* @private
*/
_requestLayoutOnTextChanged(): void;
/**
* @private
*/
_setNativeText(): void;
//@endprivate
}

View File

@ -1,6 +1,9 @@
/**
* @module "ui/text-base"
*
* Contains the TextField class, which represents an editable single-line box.
*/
*/ /** */
import { EditableTextBase, Property } from "../editable-text-base";
export const secureProperty: Property<TextField, boolean>;

View File

@ -1,6 +1,9 @@
/**
* @module "ui/text-view"
*
* Contains the TextView class, which represents an editable multi-line line box.
*/
*/ /** */
import { EditableTextBase } from "../editable-text-base";
/**

View File

@ -1,6 +1,9 @@
/**
* @module "ui/time-picker"
*
* Contains the TimePicker class.
*/
*/ /** */
import { View, Property } from "../core/view";
/**

View File

@ -1,4 +1,8 @@
import { Transition } from "./transition";
/**
* @module "ui/transition/fade-transition"
*/ /** */
import { Transition } from "../transition";
export class FadeTransition extends Transition {
constructor(duration: number, nativeCurve: any);

View File

@ -1,4 +1,8 @@
import { Transition } from "./transition";
/**
* @module "ui/transition/slide-transition"
*/ /** */
import { Transition } from "../transition";
export class SlideTransition extends Transition {
constructor(direction: string, duration: number, nativeCurve: any);

View File

@ -1,4 +1,8 @@
import { NavigationTransition } from "../frame";
/**
* @module "ui/transition"
*/ /** */
import { NavigationTransition } from "../frame";
import { Page } from "../page";
export module AndroidTransitionType {
@ -18,14 +22,40 @@ export class Transition {
}
//@private
/**
* @private
*/
export function _clearBackwardTransitions(fragment: any): void;
/**
* @private
*/
export function _clearForwardTransitions(fragment: any): void;
/**
* @private
*/
export function _setAndroidFragmentTransitions(cachePagesOnNavigate: boolean, navigationTransition: NavigationTransition, currentFragment: any, newFragment: any, fragmentTransaction: any): void;
/**
* @private
*/
export function _onFragmentCreateAnimator(fragment: any, nextAnim: number): any;
/**
* @private
*/
export function _onFragmentShown(fragment: any, isBack: boolean): void;
/**
* @private
*/
export function _onFragmentHidden(fragment: any, isBack: boolean, destroyed: boolean): void;
/**
* @private
*/
export function _removePageNativeViewFromAndroidParent(page: Page): void;
/**
* @private
*/
export function _prepareCurrentFragmentForClearHistory(fragment: any): void;
/**
* @private
*/
export function _createIOSAnimatedTransitioning(navigationTransition: NavigationTransition, nativeCurve: any, operation: number, fromVC: any, toVC: any): any;
//@endprivate

View File

@ -1,4 +1,8 @@
import { View } from "./core/view";
/**
* @module "ui/utils"
*/ /** */
import { View } from "./core/view";
export module ios {
/**
* Gets actual height of a [UIView](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIView_Class/) widget.

View File

@ -1,6 +1,9 @@
/**
* @module "ui/transition"
*
* Contains the WebView class, which represents a standard browser widget.
*/
*/ /** */
import { View, Property, EventData } from "../core/view";
/**

View File

@ -1,3 +1,7 @@
/**
* @module "utils/debug"
*/ /** */
/**
* A runtime option indicating whether the build has debugging enabled.
*/

View File

@ -1,3 +1,7 @@
/**
* @module "utils/lazy"
*/ /** */
/**
* A function that evaluates the action only once.
* @param action The action to be evaluated to get the result.

View File

@ -1,4 +1,8 @@
/**
* @module "utils/types"
*/ /** */
/**
* A function that checks if something is a valid string.
* @param value The value which will be checked.
* Returns true if value is a string.

View File

@ -1,15 +1,21 @@
/**
* @module "utils/utils"
*/ /** */
export var RESOURCE_PREFIX: string;
//@private
/**
* Used by various android event listener implementations
* Used by various android event listener implementations.
* @private
*/
interface Owned {
owner: any;
}
/**
* Used to cache and restore Android views' layer type, i.e. android.view.View.getLayerType and android.view.View.setLayerType.
* Used to cache and restore Android views' layer type, i.e. android.view.View.getLayerType and android.view.View.setLayerType.
* @private
*/
interface CacheLayerType {
layerType: number;

View File

@ -1,6 +1,7 @@
/**
* Contains the XmlParser class, which is a SAX parser using the easysax implementation
*/
* @module "xml"
* Contains the XmlParser class, which is a SAX parser using the easysax implementation.
*/ /** */
/**
* Specifies the type of parser event.

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