diff --git a/gruntfile.js b/gruntfile.js index 6b5f6a43b..ebb5b5437 100644 --- a/gruntfile.js +++ b/gruntfile.js @@ -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; }; diff --git a/package.json b/package.json index 5dde84d4c..5012d1155 100644 --- a/package.json +++ b/package.json @@ -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/**'" diff --git a/tns-core-modules/application-settings/application-settings.d.ts b/tns-core-modules/application-settings/application-settings.d.ts index e6e46bd1c..e6ce94746 100644 --- a/tns-core-modules/application-settings/application-settings.d.ts +++ b/tns-core-modules/application-settings/application-settings.d.ts @@ -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. diff --git a/tns-core-modules/application/application.d.ts b/tns-core-modules/application/application.d.ts index 1c89b11d1..a8d57b398 100644 --- a/tns-core-modules/application/application.d.ts +++ b/tns-core-modules/application/application.d.ts @@ -1,7 +1,10 @@ -/// Include global typings -/** +/** + * @module "application" + * * Contains the application abstraction with all related methods. - */ + */ /** */ + +/// Include global typings import { NavigationEntry, View, Observable, EventData } from "../ui/frame"; /** diff --git a/tns-core-modules/color/color.d.ts b/tns-core-modules/color/color.d.ts index 1e24bd007..db4a098e6 100644 --- a/tns-core-modules/color/color.d.ts +++ b/tns-core-modules/color/color.d.ts @@ -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. */ diff --git a/tns-core-modules/color/known-colors.d.ts b/tns-core-modules/color/known-colors.d.ts index 48c4e077c..75121d701 100644 --- a/tns-core-modules/color/known-colors.d.ts +++ b/tns-core-modules/color/known-colors.d.ts @@ -1,4 +1,8 @@ -export var AliceBlue; +/** + * @module "color/known-colors" + */ /** */ + +export var AliceBlue; export var AntiqueWhite; export var Aqua; export var Aquamarine; diff --git a/tns-core-modules/connectivity/connectivity.d.ts b/tns-core-modules/connectivity/connectivity.d.ts index 132d08cc2..2d465f1f0 100644 --- a/tns-core-modules/connectivity/connectivity.d.ts +++ b/tns-core-modules/connectivity/connectivity.d.ts @@ -1,6 +1,9 @@ /** + * @module "connectivity" + * * Contains connectivity utility methods. - */ + */ /** */ + /** * Gets the type of connection. * Returns a value from the connectivity.connectionType enumeration. diff --git a/tns-core-modules/css-value/reworkcss-value.d.ts b/tns-core-modules/css-value/reworkcss-value.d.ts index 72aeabe02..d022d3eeb 100644 --- a/tns-core-modules/css-value/reworkcss-value.d.ts +++ b/tns-core-modules/css-value/reworkcss-value.d.ts @@ -1,3 +1,7 @@ +/** + * @module "css-value" + */ /** */ + interface CSSValue { type: string; string: string; diff --git a/tns-core-modules/css/reworkcss.d.ts b/tns-core-modules/css/reworkcss.d.ts index ce7d3ecc7..b7376381b 100644 --- a/tns-core-modules/css/reworkcss.d.ts +++ b/tns-core-modules/css/reworkcss.d.ts @@ -1,3 +1,7 @@ +/** + * @module "css" + */ /** */ + export interface Position { start: { line: number; column: number }; end: { line: number; column: number }; diff --git a/tns-core-modules/data/observable-array/observable-array.d.ts b/tns-core-modules/data/observable-array/observable-array.d.ts index 7f05e5702..da118a340 100644 --- a/tns-core-modules/data/observable-array/observable-array.d.ts +++ b/tns-core-modules/data/observable-array/observable-array.d.ts @@ -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"; /** diff --git a/tns-core-modules/data/observable/observable.d.ts b/tns-core-modules/data/observable/observable.d.ts index fd37e2f24..10e6a4ed8 100644 --- a/tns-core-modules/data/observable/observable.d.ts +++ b/tns-core-modules/data/observable/observable.d.ts @@ -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 } diff --git a/tns-core-modules/data/virtual-array/virtual-array.d.ts b/tns-core-modules/data/virtual-array/virtual-array.d.ts index f9ccacafb..625884373 100644 --- a/tns-core-modules/data/virtual-array/virtual-array.d.ts +++ b/tns-core-modules/data/virtual-array/virtual-array.d.ts @@ -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"; diff --git a/tns-core-modules/docs-shims.d.ts b/tns-core-modules/docs-shims.d.ts deleted file mode 100644 index e5534ebd9..000000000 --- a/tns-core-modules/docs-shims.d.ts +++ /dev/null @@ -1,68 +0,0 @@ -declare type Promise = any; -declare type Set = any; -declare type Map = 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; - has(name: string): boolean; - set(name: string, value: string): void; -} - -declare class Body { - bodyUsed: boolean; - /* - arrayBuffer(): Promise; - blob(): Promise; - */ - formData(): Promise; - json(): Promise; - text(): Promise; -} - -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; diff --git a/tns-core-modules/file-system/file-name-resolver/file-name-resolver.d.ts b/tns-core-modules/file-system/file-name-resolver/file-name-resolver.d.ts index 24ee7faac..2efdf7c69 100644 --- a/tns-core-modules/file-system/file-name-resolver/file-name-resolver.d.ts +++ b/tns-core-modules/file-system/file-name-resolver/file-name-resolver.d.ts @@ -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; diff --git a/tns-core-modules/file-system/file-system-access.d.ts b/tns-core-modules/file-system/file-system-access.d.ts index f025a224f..4ad4f01d3 100644 --- a/tns-core-modules/file-system/file-system-access.d.ts +++ b/tns-core-modules/file-system/file-system-access.d.ts @@ -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 { diff --git a/tns-core-modules/file-system/file-system.d.ts b/tns-core-modules/file-system/file-system.d.ts index 8b5268806..5e96e7e69 100644 --- a/tns-core-modules/file-system/file-system.d.ts +++ b/tns-core-modules/file-system/file-system.d.ts @@ -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. diff --git a/tns-core-modules/fps-meter/fps-meter.d.ts b/tns-core-modules/fps-meter/fps-meter.d.ts index 62db11e13..1902b133b 100644 --- a/tns-core-modules/fps-meter/fps-meter.d.ts +++ b/tns-core-modules/fps-meter/fps-meter.d.ts @@ -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. diff --git a/tns-core-modules/fps-meter/fps-native.d.ts b/tns-core-modules/fps-meter/fps-native.d.ts index 2327ae062..91ee3d01a 100644 --- a/tns-core-modules/fps-meter/fps-native.d.ts +++ b/tns-core-modules/fps-meter/fps-native.d.ts @@ -1,4 +1,7 @@ - +/** + * @module "fps-meter/fps-native" + */ /** */ + /** * An utility class used to measure frames per second. */ diff --git a/tns-core-modules/http/http-request/http-request.d.ts b/tns-core-modules/http/http-request/http-request.d.ts index ca5e8877a..5907ee534 100644 --- a/tns-core-modules/http/http-request/http-request.d.ts +++ b/tns-core-modules/http/http-request/http-request.d.ts @@ -1,4 +1,9 @@ -//@private +/** + * @module "http/http-request" + * @private + */ /** */ + +//@private import * as http from ".."; export var request: (options: http.HttpRequestOptions) => Promise; diff --git a/tns-core-modules/http/http.d.ts b/tns-core-modules/http/http.d.ts index 2fa2f1c2a..787e9d4b7 100644 --- a/tns-core-modules/http/http.d.ts +++ b/tns-core-modules/http/http.d.ts @@ -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"; diff --git a/tns-core-modules/image-asset/image-asset.d.ts b/tns-core-modules/image-asset/image-asset.d.ts index 4052c374a..d9d432d65 100644 --- a/tns-core-modules/image-asset/image-asset.d.ts +++ b/tns-core-modules/image-asset/image-asset.d.ts @@ -1,3 +1,7 @@ +/** + * @module "image-asset" + */ /** */ + import { Observable } from "../data/observable"; export class ImageAsset extends Observable { diff --git a/tns-core-modules/image-source/image-source.d.ts b/tns-core-modules/image-source/image-source.d.ts index 57a9fcf92..82f966cae 100644 --- a/tns-core-modules/image-source/image-source.d.ts +++ b/tns-core-modules/image-source/image-source.d.ts @@ -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. diff --git a/tns-core-modules/js-libs/easysax/easysax.d.ts b/tns-core-modules/js-libs/easysax/easysax.d.ts index 6fb14f9fb..2f8b06099 100644 --- a/tns-core-modules/js-libs/easysax/easysax.d.ts +++ b/tns-core-modules/js-libs/easysax/easysax.d.ts @@ -1,4 +1,9 @@ -//@private +/** + * @module "js-libs/easysax" + * @private + */ /** */ + +//@private export class EasySAXParser { constructor(); parse(xml: string): void; diff --git a/tns-core-modules/js-libs/esprima/esprima.d.ts b/tns-core-modules/js-libs/esprima/esprima.d.ts index 6171380f2..9ce9dd962 100644 --- a/tns-core-modules/js-libs/esprima/esprima.d.ts +++ b/tns-core-modules/js-libs/esprima/esprima.d.ts @@ -1,4 +1,8 @@ -/* tslint:disable */ +/** + * @module "js-libs/esprima" + */ /** */ + +/* tslint:disable */ // Type definitions for Esprima v1.2.0 // Project: http://esprima.org diff --git a/tns-core-modules/js-libs/polymer-expressions/polymer-expressions.d.ts b/tns-core-modules/js-libs/polymer-expressions/polymer-expressions.d.ts index 444f06fc7..f84afd00a 100644 --- a/tns-core-modules/js-libs/polymer-expressions/polymer-expressions.d.ts +++ b/tns-core-modules/js-libs/polymer-expressions/polymer-expressions.d.ts @@ -1,4 +1,9 @@ -//@private +/** + * @module "js-libs/polymer-expressions" + * @private + */ /** */ + +//@private export class PolymerExpressions { static getExpression(expression: string): Expression; } diff --git a/tns-core-modules/platform/platform.d.ts b/tns-core-modules/platform/platform.d.ts index 4e40e38cd..a05f1addf 100644 --- a/tns-core-modules/platform/platform.d.ts +++ b/tns-core-modules/platform/platform.d.ts @@ -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. diff --git a/tns-core-modules/text/formatted-string.d.ts b/tns-core-modules/text/formatted-string.d.ts index ece49b37f..32136ca83 100644 --- a/tns-core-modules/text/formatted-string.d.ts +++ b/tns-core-modules/text/formatted-string.d.ts @@ -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"; diff --git a/tns-core-modules/text/span.d.ts b/tns-core-modules/text/span.d.ts index 706709e97..7cc9258ee 100644 --- a/tns-core-modules/text/span.d.ts +++ b/tns-core-modules/text/span.d.ts @@ -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 } diff --git a/tns-core-modules/text/text.d.ts b/tns-core-modules/text/text.d.ts index 60245e92f..b604cc0db 100644 --- a/tns-core-modules/text/text.d.ts +++ b/tns-core-modules/text/text.d.ts @@ -1,6 +1,9 @@ /** + * @module "text" + * * Defines specific text related enumerations. - */ + */ /** */ + /** * Defines the supported character encodings. */ diff --git a/tns-core-modules/timer/timer.d.ts b/tns-core-modules/timer/timer.d.ts index e0a07a283..e21f7b4d7 100644 --- a/tns-core-modules/timer/timer.d.ts +++ b/tns-core-modules/timer/timer.d.ts @@ -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. diff --git a/tns-core-modules/trace/trace.d.ts b/tns-core-modules/trace/trace.d.ts index 43b633ad6..f457eb1ea 100644 --- a/tns-core-modules/trace/trace.d.ts +++ b/tns-core-modules/trace/trace.d.ts @@ -1,6 +1,9 @@ /** + * @module "trace" + * * Allows you to trace and print specific information based on categories. - */ + */ /** */ + /** * Enables the trace module. */ diff --git a/tns-core-modules/ui/action-bar/action-bar.d.ts b/tns-core-modules/ui/action-bar/action-bar.d.ts index 2513e0c5e..b8ceb697b 100644 --- a/tns-core-modules/ui/action-bar/action-bar.d.ts +++ b/tns-core-modules/ui/action-bar/action-bar.d.ts @@ -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 diff --git a/tns-core-modules/ui/activity-indicator/activity-indicator.d.ts b/tns-core-modules/ui/activity-indicator/activity-indicator.d.ts index ea65c7c56..ab33a27e2 100644 --- a/tns-core-modules/ui/activity-indicator/activity-indicator.d.ts +++ b/tns-core-modules/ui/activity-indicator/activity-indicator.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/animation/animation.d.ts b/tns-core-modules/ui/animation/animation.d.ts index b8afae618..b5f47077a 100644 --- a/tns-core-modules/ui/animation/animation.d.ts +++ b/tns-core-modules/ui/animation/animation.d.ts @@ -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. diff --git a/tns-core-modules/ui/animation/keyframe-animation.d.ts b/tns-core-modules/ui/animation/keyframe-animation.d.ts index a118e658d..750806276 100644 --- a/tns-core-modules/ui/animation/keyframe-animation.d.ts +++ b/tns-core-modules/ui/animation/keyframe-animation.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/animation/keyframe-animation" + */ /** */ + import { View } from "../core/view"; export interface KeyframeDeclaration { diff --git a/tns-core-modules/ui/border/border.d.ts b/tns-core-modules/ui/border/border.d.ts index cc8e57a49..f24dcd712 100644 --- a/tns-core-modules/ui/border/border.d.ts +++ b/tns-core-modules/ui/border/border.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/animation/keyframe-animation" + * * Contains the Border class, which represents a UI border component. - */ + */ /** */ + import { ContentView } from "../content-view"; /** diff --git a/tns-core-modules/ui/builder/binding-builder.d.ts b/tns-core-modules/ui/builder/binding-builder.d.ts index 59c932d82..2eed5b7a4 100644 --- a/tns-core-modules/ui/builder/binding-builder.d.ts +++ b/tns-core-modules/ui/builder/binding-builder.d.ts @@ -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; -} diff --git a/tns-core-modules/ui/builder/builder.d.ts b/tns-core-modules/ui/builder/builder.d.ts index 3779c4bbe..fc9962fcf 100644 --- a/tns-core-modules/ui/builder/builder.d.ts +++ b/tns-core-modules/ui/builder/builder.d.ts @@ -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; diff --git a/tns-core-modules/ui/builder/component-builder/component-builder.d.ts b/tns-core-modules/ui/builder/component-builder/component-builder.d.ts index 0e76f7231..aee2eb915 100644 --- a/tns-core-modules/ui/builder/component-builder/component-builder.d.ts +++ b/tns-core-modules/ui/builder/component-builder/component-builder.d.ts @@ -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; diff --git a/tns-core-modules/ui/button/button.d.ts b/tns-core-modules/ui/button/button.d.ts index 6058205fc..3b49da21b 100644 --- a/tns-core-modules/ui/button/button.d.ts +++ b/tns-core-modules/ui/button/button.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/button" + * * Contains the Button class, which represents a standard button widget. - */ + */ /** */ + import { TextBase, EventData } from "../text-base"; /** diff --git a/tns-core-modules/ui/content-view/content-view.d.ts b/tns-core-modules/ui/content-view/content-view.d.ts index 906c65b27..f57978ca8 100644 --- a/tns-core-modules/ui/content-view/content-view.d.ts +++ b/tns-core-modules/ui/content-view/content-view.d.ts @@ -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. */ diff --git a/tns-core-modules/ui/core/bindable/bindable.d.ts b/tns-core-modules/ui/core/bindable/bindable.d.ts index 4d962c0f2..b4bbd6ddf 100644 --- a/tns-core-modules/ui/core/bindable/bindable.d.ts +++ b/tns-core-modules/ui/core/bindable/bindable.d.ts @@ -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"; diff --git a/tns-core-modules/ui/core/control-state-change/control-state-change.d.ts b/tns-core-modules/ui/core/control-state-change/control-state-change.d.ts index 77b104264..da29230cd 100644 --- a/tns-core-modules/ui/core/control-state-change/control-state-change.d.ts +++ b/tns-core-modules/ui/core/control-state-change/control-state-change.d.ts @@ -1,4 +1,8 @@ /** + * @module "ui/core/control-state-change" + */ /** */ + +/** * An utility class used for supporting styling infrastructure. */ export class ControlStateChangeListener { diff --git a/tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts b/tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts index f7e421f36..218d19db8 100644 --- a/tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts +++ b/tns-core-modules/ui/core/dependency-observable/dependency-observable.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/core/properties/properties.d.ts b/tns-core-modules/ui/core/properties/properties.d.ts index 9fb03194b..1f611379b 100644 --- a/tns-core-modules/ui/core/properties/properties.d.ts +++ b/tns-core-modules/ui/core/properties/properties.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/core/properties" + */ /** */ + import { ViewBase } from "../view-base"; import { Style } from "../../styling/style"; diff --git a/tns-core-modules/ui/core/view-base/view-base.d.ts b/tns-core-modules/ui/core/view-base/view-base.d.ts index abc7defa4..38cbfb4f3 100644 --- a/tns-core-modules/ui/core/view-base/view-base.d.ts +++ b/tns-core-modules/ui/core/view-base/view-base.d.ts @@ -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 diff --git a/tns-core-modules/ui/core/view/view.d.ts b/tns-core-modules/ui/core/view/view.d.ts index a45bbd362..25336cb16 100644 --- a/tns-core-modules/ui/core/view/view.d.ts +++ b/tns-core-modules/ui/core/view/view.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/core/view" + */ /** */ + /// 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 } diff --git a/tns-core-modules/ui/core/weak-event-listener/weak-event-listener.d.ts b/tns-core-modules/ui/core/weak-event-listener/weak-event-listener.d.ts index c74641737..8dd444e12 100644 --- a/tns-core-modules/ui/core/weak-event-listener/weak-event-listener.d.ts +++ b/tns-core-modules/ui/core/weak-event-listener/weak-event-listener.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/core/weak-event-listener" + */ /** */ + import { Observable, EventData } from "../../../data/observable"; /** diff --git a/tns-core-modules/ui/date-picker/date-picker.d.ts b/tns-core-modules/ui/date-picker/date-picker.d.ts index d3ed404bb..dd0d5e9c8 100644 --- a/tns-core-modules/ui/date-picker/date-picker.d.ts +++ b/tns-core-modules/ui/date-picker/date-picker.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/date-picker" + * * Contains the DatePicker class. - */ + */ /** */ + import { View, Property } from "../core/view"; export const yearProperty: Property; diff --git a/tns-core-modules/ui/dialogs/dialogs.d.ts b/tns-core-modules/ui/dialogs/dialogs.d.ts index 394220318..a7259c8ba 100644 --- a/tns-core-modules/ui/dialogs/dialogs.d.ts +++ b/tns-core-modules/ui/dialogs/dialogs.d.ts @@ -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. */ diff --git a/tns-core-modules/ui/editable-text-base/editable-text-base.d.ts b/tns-core-modules/ui/editable-text-base/editable-text-base.d.ts index 5dfe2a7b2..1be73f162 100644 --- a/tns-core-modules/ui/editable-text-base/editable-text-base.d.ts +++ b/tns-core-modules/ui/editable-text-base/editable-text-base.d.ts @@ -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; export const placeholderColorProperty: CssProperty; //@private +/** + * @private + */ export function _updateCharactersInRangeReplacementString(formattedText: FormattedString, rangeLocation: number, rangeLength: number, replacementString: string): void; //@endprivate diff --git a/tns-core-modules/ui/enums/enums.d.ts b/tns-core-modules/ui/enums/enums.d.ts index 86197808e..d75378e8a 100644 --- a/tns-core-modules/ui/enums/enums.d.ts +++ b/tns-core-modules/ui/enums/enums.d.ts @@ -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. diff --git a/tns-core-modules/ui/frame/frame.d.ts b/tns-core-modules/ui/frame/frame.d.ts index 1dd008690..ac69b458c 100644 --- a/tns-core-modules/ui/frame/frame.d.ts +++ b/tns-core-modules/ui/frame/frame.d.ts @@ -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 diff --git a/tns-core-modules/ui/gestures/gestures.d.ts b/tns-core-modules/ui/gestures/gestures.d.ts index ddfb69e95..68ebb516d 100644 --- a/tns-core-modules/ui/gestures/gestures.d.ts +++ b/tns-core-modules/ui/gestures/gestures.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/html-view/html-view.d.ts b/tns-core-modules/ui/html-view/html-view.d.ts index 8f2f62508..20558528a 100644 --- a/tns-core-modules/ui/html-view/html-view.d.ts +++ b/tns-core-modules/ui/html-view/html-view.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/image-cache/image-cache.d.ts b/tns-core-modules/ui/image-cache/image-cache.d.ts index 4fa2bae2b..72ead9103 100644 --- a/tns-core-modules/ui/image-cache/image-cache.d.ts +++ b/tns-core-modules/ui/image-cache/image-cache.d.ts @@ -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 } diff --git a/tns-core-modules/ui/image/image.d.ts b/tns-core-modules/ui/image/image.d.ts index 8277e6158..dbb51a254 100644 --- a/tns-core-modules/ui/image/image.d.ts +++ b/tns-core-modules/ui/image/image.d.ts @@ -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"; diff --git a/tns-core-modules/ui/label/label.d.ts b/tns-core-modules/ui/label/label.d.ts index 8488b1c01..1afe5431f 100644 --- a/tns-core-modules/ui/label/label.d.ts +++ b/tns-core-modules/ui/label/label.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/label" + * * Contains the Label class, which represents a standard label widget. - */ + */ /** */ + import { TextBase } from "../text-base"; /** diff --git a/tns-core-modules/ui/layouts/absolute-layout/absolute-layout.d.ts b/tns-core-modules/ui/layouts/absolute-layout/absolute-layout.d.ts index 3bdcd46f5..840993e76 100644 --- a/tns-core-modules/ui/layouts/absolute-layout/absolute-layout.d.ts +++ b/tns-core-modules/ui/layouts/absolute-layout/absolute-layout.d.ts @@ -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. diff --git a/tns-core-modules/ui/layouts/dock-layout/dock-layout.d.ts b/tns-core-modules/ui/layouts/dock-layout/dock-layout.d.ts index 6f1e82509..b44ceb39c 100644 --- a/tns-core-modules/ui/layouts/dock-layout/dock-layout.d.ts +++ b/tns-core-modules/ui/layouts/dock-layout/dock-layout.d.ts @@ -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. diff --git a/tns-core-modules/ui/layouts/flexbox-layout/flexbox-layout.d.ts b/tns-core-modules/ui/layouts/flexbox-layout/flexbox-layout.d.ts index ac88e5d6d..2c6925ecd 100644 --- a/tns-core-modules/ui/layouts/flexbox-layout/flexbox-layout.d.ts +++ b/tns-core-modules/ui/layouts/flexbox-layout/flexbox-layout.d.ts @@ -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"; diff --git a/tns-core-modules/ui/layouts/grid-layout/grid-layout.d.ts b/tns-core-modules/ui/layouts/grid-layout/grid-layout.d.ts index 64f44f6f1..4ee7bc383 100644 --- a/tns-core-modules/ui/layouts/grid-layout/grid-layout.d.ts +++ b/tns-core-modules/ui/layouts/grid-layout/grid-layout.d.ts @@ -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; //@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 } diff --git a/tns-core-modules/ui/layouts/layout-base.d.ts b/tns-core-modules/ui/layouts/layout-base.d.ts index b1419fda0..ded023594 100644 --- a/tns-core-modules/ui/layouts/layout-base.d.ts +++ b/tns-core-modules/ui/layouts/layout-base.d.ts @@ -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"; diff --git a/tns-core-modules/ui/layouts/layout.d.ts b/tns-core-modules/ui/layouts/layout.d.ts index a91f4305d..38864c973 100644 --- a/tns-core-modules/ui/layouts/layout.d.ts +++ b/tns-core-modules/ui/layouts/layout.d.ts @@ -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. diff --git a/tns-core-modules/ui/layouts/stack-layout/stack-layout.d.ts b/tns-core-modules/ui/layouts/stack-layout/stack-layout.d.ts index 867dd6199..f3a573fe8 100644 --- a/tns-core-modules/ui/layouts/stack-layout/stack-layout.d.ts +++ b/tns-core-modules/ui/layouts/stack-layout/stack-layout.d.ts @@ -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. diff --git a/tns-core-modules/ui/layouts/wrap-layout/wrap-layout.d.ts b/tns-core-modules/ui/layouts/wrap-layout/wrap-layout.d.ts index 082983170..ce1214eee 100644 --- a/tns-core-modules/ui/layouts/wrap-layout/wrap-layout.d.ts +++ b/tns-core-modules/ui/layouts/wrap-layout/wrap-layout.d.ts @@ -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 diff --git a/tns-core-modules/ui/list-picker/list-picker.d.ts b/tns-core-modules/ui/list-picker/list-picker.d.ts index c9d29ec25..34da6d4f5 100644 --- a/tns-core-modules/ui/list-picker/list-picker.d.ts +++ b/tns-core-modules/ui/list-picker/list-picker.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/list-picker" + * * Contains the ListPicker class. - */ + */ /** */ + import { View, Property } from "../core/view"; /** diff --git a/tns-core-modules/ui/list-view/list-view.d.ts b/tns-core-modules/ui/list-view/list-view.d.ts index 8f4f7cb55..029e55dd3 100644 --- a/tns-core-modules/ui/list-view/list-view.d.ts +++ b/tns-core-modules/ui/list-view/list-view.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/page/page.d.ts b/tns-core-modules/ui/page/page.d.ts index aa640297e..8967d1b45 100644 --- a/tns-core-modules/ui/page/page.d.ts +++ b/tns-core-modules/ui/page/page.d.ts @@ -1,7 +1,10 @@ -/// 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. + */ /** */ + +/// 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 } diff --git a/tns-core-modules/ui/placeholder/placeholder.d.ts b/tns-core-modules/ui/placeholder/placeholder.d.ts index dd905efdd..35fa3052b 100644 --- a/tns-core-modules/ui/placeholder/placeholder.d.ts +++ b/tns-core-modules/ui/placeholder/placeholder.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/progress/progress.d.ts b/tns-core-modules/ui/progress/progress.d.ts index d02524646..7664bbc81 100644 --- a/tns-core-modules/ui/progress/progress.d.ts +++ b/tns-core-modules/ui/progress/progress.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/proxy-view-container/proxy-view-container.d.ts b/tns-core-modules/ui/proxy-view-container/proxy-view-container.d.ts index 6f4f88824..92e618e12 100644 --- a/tns-core-modules/ui/proxy-view-container/proxy-view-container.d.ts +++ b/tns-core-modules/ui/proxy-view-container/proxy-view-container.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/proxy-view-container" + */ /** */ + import { LayoutBase } from "../layouts/layout-base"; export class ProxyViewContainer extends LayoutBase { diff --git a/tns-core-modules/ui/repeater/repeater.d.ts b/tns-core-modules/ui/repeater/repeater.d.ts index f70b2b9ff..33bc6c60c 100644 --- a/tns-core-modules/ui/repeater/repeater.d.ts +++ b/tns-core-modules/ui/repeater/repeater.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/scroll-view/scroll-view.d.ts b/tns-core-modules/ui/scroll-view/scroll-view.d.ts index 40f676cba..9bd697eff 100644 --- a/tns-core-modules/ui/scroll-view/scroll-view.d.ts +++ b/tns-core-modules/ui/scroll-view/scroll-view.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/search-bar/search-bar.d.ts b/tns-core-modules/ui/search-bar/search-bar.d.ts index 3318f79d8..5efe69b56 100644 --- a/tns-core-modules/ui/search-bar/search-bar.d.ts +++ b/tns-core-modules/ui/search-bar/search-bar.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/segmented-bar/segmented-bar.d.ts b/tns-core-modules/ui/segmented-bar/segmented-bar.d.ts index 6eac0cf10..1f3bddb8f 100644 --- a/tns-core-modules/ui/segmented-bar/segmented-bar.d.ts +++ b/tns-core-modules/ui/segmented-bar/segmented-bar.d.ts @@ -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 diff --git a/tns-core-modules/ui/slider/slider.d.ts b/tns-core-modules/ui/slider/slider.d.ts index 36e2c1df9..a726c722f 100644 --- a/tns-core-modules/ui/slider/slider.d.ts +++ b/tns-core-modules/ui/slider/slider.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/slider" + * * Contains the Slider class, which represents a standard slider component. - */ + */ /** */ + import { View, Property, CoercibleProperty } from "../core/view"; /** diff --git a/tns-core-modules/ui/styling/background.d.ts b/tns-core-modules/ui/styling/background.d.ts index abe4d8d0c..e84e9e0bd 100644 --- a/tns-core-modules/ui/styling/background.d.ts +++ b/tns-core-modules/ui/styling/background.d.ts @@ -1,3 +1,7 @@ +/** + * @module "ui/styling/background" + */ /** */ + import { ImageSource } from "../../image-source"; import { Color } from "../../color"; import { View, BackgroundRepeat } from "../core/view"; diff --git a/tns-core-modules/ui/styling/css-selector-parser.d.ts b/tns-core-modules/ui/styling/css-selector-parser.d.ts index 7b3a309a5..7824a782e 100644 --- a/tns-core-modules/ui/styling/css-selector-parser.d.ts +++ b/tns-core-modules/ui/styling/css-selector-parser.d.ts @@ -1,3 +1,8 @@ +/** + * @module "ui/styling/css-selector-parser" + * @private + */ /** */ + //@private export interface SimpleSelector { pos: number; diff --git a/tns-core-modules/ui/styling/css-selector/css-selector.d.ts b/tns-core-modules/ui/styling/css-selector/css-selector.d.ts index b72c47667..994bb7226 100644 --- a/tns-core-modules/ui/styling/css-selector/css-selector.d.ts +++ b/tns-core-modules/ui/styling/css-selector/css-selector.d.ts @@ -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. diff --git a/tns-core-modules/ui/styling/font.d.ts b/tns-core-modules/ui/styling/font.d.ts index 5d9805d64..f6ec2a790 100644 --- a/tns-core-modules/ui/styling/font.d.ts +++ b/tns-core-modules/ui/styling/font.d.ts @@ -1,4 +1,8 @@ -export class Font { +/** + * @module "ui/styling/font" + */ /** */ + +export class Font { public static default: Font; public fontFamily: string; diff --git a/tns-core-modules/ui/styling/style-properties.d.ts b/tns-core-modules/ui/styling/style-properties.d.ts index fc5e3f5b6..a885405d7 100644 --- a/tns-core-modules/ui/styling/style-properties.d.ts +++ b/tns-core-modules/ui/styling/style-properties.d.ts @@ -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"; diff --git a/tns-core-modules/ui/styling/style-scope.d.ts b/tns-core-modules/ui/styling/style-scope.d.ts index 913673944..4e2167754 100644 --- a/tns-core-modules/ui/styling/style-scope.d.ts +++ b/tns-core-modules/ui/styling/style-scope.d.ts @@ -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 { /** diff --git a/tns-core-modules/ui/styling/style/style.d.ts b/tns-core-modules/ui/styling/style/style.d.ts index 87f0219f9..21a9f1fad 100644 --- a/tns-core-modules/ui/styling/style/style.d.ts +++ b/tns-core-modules/ui/styling/style/style.d.ts @@ -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; diff --git a/tns-core-modules/ui/switch/switch.d.ts b/tns-core-modules/ui/switch/switch.d.ts index c78fb2857..38b8626be 100644 --- a/tns-core-modules/ui/switch/switch.d.ts +++ b/tns-core-modules/ui/switch/switch.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/switch" + * * Contains the Switch class, which represents a standard switch component. - */ + */ /** */ + import { View, Property } from "../core/view"; /** diff --git a/tns-core-modules/ui/tab-view/tab-view.d.ts b/tns-core-modules/ui/tab-view/tab-view.d.ts index 920b84514..dc6e9a74d 100644 --- a/tns-core-modules/ui/tab-view/tab-view.d.ts +++ b/tns-core-modules/ui/tab-view/tab-view.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/text-base/text-base.d.ts b/tns-core-modules/ui/text-base/text-base.d.ts index f2eecd9f4..c23b45dab 100644 --- a/tns-core-modules/ui/text-base/text-base.d.ts +++ b/tns-core-modules/ui/text-base/text-base.d.ts @@ -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 } diff --git a/tns-core-modules/ui/text-field/text-field.d.ts b/tns-core-modules/ui/text-field/text-field.d.ts index 2798f4aae..4cc16bf1c 100644 --- a/tns-core-modules/ui/text-field/text-field.d.ts +++ b/tns-core-modules/ui/text-field/text-field.d.ts @@ -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; diff --git a/tns-core-modules/ui/text-view/text-view.d.ts b/tns-core-modules/ui/text-view/text-view.d.ts index 9f553a8e8..48e93f40b 100644 --- a/tns-core-modules/ui/text-view/text-view.d.ts +++ b/tns-core-modules/ui/text-view/text-view.d.ts @@ -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"; /** diff --git a/tns-core-modules/ui/time-picker/time-picker.d.ts b/tns-core-modules/ui/time-picker/time-picker.d.ts index 1537e1d20..2b02a19c5 100644 --- a/tns-core-modules/ui/time-picker/time-picker.d.ts +++ b/tns-core-modules/ui/time-picker/time-picker.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/time-picker" + * * Contains the TimePicker class. - */ + */ /** */ + import { View, Property } from "../core/view"; /** diff --git a/tns-core-modules/ui/transition/fade-transition.d.ts b/tns-core-modules/ui/transition/fade-transition.d.ts index 7c36318ab..aae3f04f0 100644 --- a/tns-core-modules/ui/transition/fade-transition.d.ts +++ b/tns-core-modules/ui/transition/fade-transition.d.ts @@ -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); diff --git a/tns-core-modules/ui/transition/slide-transition.d.ts b/tns-core-modules/ui/transition/slide-transition.d.ts index d41e4393b..31275755b 100644 --- a/tns-core-modules/ui/transition/slide-transition.d.ts +++ b/tns-core-modules/ui/transition/slide-transition.d.ts @@ -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); diff --git a/tns-core-modules/ui/transition/transition.d.ts b/tns-core-modules/ui/transition/transition.d.ts index c44709e1e..ca5585833 100644 --- a/tns-core-modules/ui/transition/transition.d.ts +++ b/tns-core-modules/ui/transition/transition.d.ts @@ -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 diff --git a/tns-core-modules/ui/utils.d.ts b/tns-core-modules/ui/utils.d.ts index 907da9420..5994b5c93 100644 --- a/tns-core-modules/ui/utils.d.ts +++ b/tns-core-modules/ui/utils.d.ts @@ -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. diff --git a/tns-core-modules/ui/web-view/web-view.d.ts b/tns-core-modules/ui/web-view/web-view.d.ts index 82c0b026a..4bf0db6ee 100644 --- a/tns-core-modules/ui/web-view/web-view.d.ts +++ b/tns-core-modules/ui/web-view/web-view.d.ts @@ -1,6 +1,9 @@ /** + * @module "ui/transition" + * * Contains the WebView class, which represents a standard browser widget. - */ + */ /** */ + import { View, Property, EventData } from "../core/view"; /** diff --git a/tns-core-modules/utils/debug.d.ts b/tns-core-modules/utils/debug.d.ts index 0712fb3ef..dfcf448a1 100644 --- a/tns-core-modules/utils/debug.d.ts +++ b/tns-core-modules/utils/debug.d.ts @@ -1,3 +1,7 @@ +/** + * @module "utils/debug" + */ /** */ + /** * A runtime option indicating whether the build has debugging enabled. */ diff --git a/tns-core-modules/utils/lazy.d.ts b/tns-core-modules/utils/lazy.d.ts index bac638454..4c1ced335 100644 --- a/tns-core-modules/utils/lazy.d.ts +++ b/tns-core-modules/utils/lazy.d.ts @@ -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. diff --git a/tns-core-modules/utils/types.d.ts b/tns-core-modules/utils/types.d.ts index f174c70ea..e006e694d 100644 --- a/tns-core-modules/utils/types.d.ts +++ b/tns-core-modules/utils/types.d.ts @@ -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. diff --git a/tns-core-modules/utils/utils.d.ts b/tns-core-modules/utils/utils.d.ts index 9000b7bf2..c72fddc93 100644 --- a/tns-core-modules/utils/utils.d.ts +++ b/tns-core-modules/utils/utils.d.ts @@ -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; diff --git a/tns-core-modules/xml/xml.d.ts b/tns-core-modules/xml/xml.d.ts index 3757fef6d..e272df174 100644 --- a/tns-core-modules/xml/xml.d.ts +++ b/tns-core-modules/xml/xml.d.ts @@ -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. diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json index dbcfd20da..14ef50445 100644 --- a/tsconfig.typedoc.json +++ b/tsconfig.typedoc.json @@ -7,10 +7,16 @@ "declaration": false, "noImplicitAny": false, "noImplicitUseStrict": true, - "experimentalDecorators": true + "experimentalDecorators": true, + "lib": [ + "es6", "dom" + ] }, - "files": [ - "tns-core-modules/docs-shims.d.ts", - "tns-core-modules/tns-core-modules.d.ts" + "include": [ + "tns-core-modules/**/*.d.ts" + ], + "exclude": [ + "tns-core-modules/references.d.ts", + "tns-core-modules/node_modules" ] }