mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-15 19:26:42 +08:00
Changing module docs so they can appear in typedoc.
This commit is contained in:
@ -57,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 --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",
|
||||
"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\"",
|
||||
"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/**'"
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "application-settings"
|
||||
*
|
||||
* Allows you to save and restore any kind of information related to your application.
|
||||
* @module "application-settings"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "application"
|
||||
*
|
||||
* Contains the application abstraction with all related methods.
|
||||
* @module "application"
|
||||
*/ /** */
|
||||
|
||||
///<reference path="../tns-core-modules.d.ts" /> Include global typings
|
||||
|
3
tns-core-modules/color/color.d.ts
vendored
3
tns-core-modules/color/color.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "color"
|
||||
*
|
||||
* Allows creating colors to be used when styling the UI.
|
||||
* @module "color"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "connectivity"
|
||||
*
|
||||
* Contains connectivity utility methods.
|
||||
* @module "connectivity"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "data/observable-array"
|
||||
*
|
||||
* Contains the ObservableArray class, which is capable of detecting and responding to changes of a collection of objects.
|
||||
* @module "data/observable-array"
|
||||
*/ /** */
|
||||
|
||||
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "data/observable"
|
||||
*
|
||||
* Contains the Observable class, which represents an observable object, or "data" in the model-view paradigm.
|
||||
* @module "data/observable"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "data/virtual-array"
|
||||
*
|
||||
* Contains the VirtualArray class, which is an advanced array like class that helps loading items on demand.
|
||||
* @module "data/virtual-array"
|
||||
*/ /** */
|
||||
|
||||
import * as observable from "../observable";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "file-system/file-name-resolver"
|
||||
*
|
||||
* Provides FileNameResolver class used for loading files based on device capabilities.
|
||||
* @module "file-system/file-name-resolver"
|
||||
*/ /** */
|
||||
|
||||
export interface PlatformContext {
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "file-system"
|
||||
*
|
||||
* Provides high-level abstractions for file system entities such as files, folders, known folders, paths, separators, etc.
|
||||
* @module "file-system"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
3
tns-core-modules/fps-meter/fps-meter.d.ts
vendored
3
tns-core-modules/fps-meter/fps-meter.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "fps-meter"
|
||||
*
|
||||
* Allows you to capture the frames-per-second metrics of your application.
|
||||
* @module "fps-meter"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
3
tns-core-modules/http/http.d.ts
vendored
3
tns-core-modules/http/http.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "http"
|
||||
*
|
||||
* Allows you to send web requests and receive the responses.
|
||||
* @module "http"
|
||||
*/ /** */
|
||||
|
||||
import * as image from "../image-source";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @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.
|
||||
* @module "image-source"
|
||||
*/ /** */
|
||||
|
||||
import * as imageAssetModule from "../image-asset";
|
||||
|
3
tns-core-modules/platform/platform.d.ts
vendored
3
tns-core-modules/platform/platform.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "platform"
|
||||
*
|
||||
* Contains all kinds of information about the device, its operating system and software.
|
||||
* @module "platform"
|
||||
*/ /** */
|
||||
|
||||
/* tslint:disable:class-name */
|
||||
|
3
tns-core-modules/text/formatted-string.d.ts
vendored
3
tns-core-modules/text/formatted-string.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "text/formatted-string"
|
||||
*
|
||||
* Contains the FormattedString and Span classes, which are used to create a formatted (rich text) strings.
|
||||
* @module "text/formatted-string"
|
||||
*/ /** */
|
||||
|
||||
import { Span } from "./span";
|
||||
|
3
tns-core-modules/text/text.d.ts
vendored
3
tns-core-modules/text/text.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "text"
|
||||
*
|
||||
* Defines specific text related enumerations.
|
||||
* @module "text"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
3
tns-core-modules/timer/timer.d.ts
vendored
3
tns-core-modules/timer/timer.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "timer"
|
||||
*
|
||||
* Allows you to create, start, stop and react to timers.
|
||||
* @module "timer"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
3
tns-core-modules/trace/trace.d.ts
vendored
3
tns-core-modules/trace/trace.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "trace"
|
||||
*
|
||||
* Allows you to trace and print specific information based on categories.
|
||||
* @module "trace"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/action-bar"
|
||||
*
|
||||
* Contains the action bar related classes.
|
||||
* @module "ui/action-bar"
|
||||
*/ /** */
|
||||
|
||||
import { EventData, ViewBase, View } from "../core/view";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/activity-indicator"
|
||||
*
|
||||
* Contains the ActivityIndicator class, which represents a widget for showing that something is currently busy.
|
||||
* @module "ui/activity-indicator"
|
||||
*/ /** */
|
||||
|
||||
import { View } from "../core/view";
|
||||
|
3
tns-core-modules/ui/border/border.d.ts
vendored
3
tns-core-modules/ui/border/border.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/animation/keyframe-animation"
|
||||
*
|
||||
* Contains the Border class, which represents a UI border component.
|
||||
* @module "ui/animation/keyframe-animation"
|
||||
*/ /** */
|
||||
|
||||
import { ContentView } from "../content-view";
|
||||
|
3
tns-core-modules/ui/button/button.d.ts
vendored
3
tns-core-modules/ui/button/button.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/button"
|
||||
*
|
||||
* Contains the Button class, which represents a standard button widget.
|
||||
* @module "ui/button"
|
||||
*/ /** */
|
||||
|
||||
import { TextBase, EventData } from "../text-base";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/content-view"
|
||||
*
|
||||
* View that can host another view.
|
||||
* @module "ui/content-view"
|
||||
*/ /** */
|
||||
|
||||
import { View, AddChildFromBuilder } from "../core/view";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/core/dependency-observable"
|
||||
*
|
||||
* Contains the DependencyObservable class, which represents an extended Observable object that uses Property instances for value backing mechanism.
|
||||
* @module "ui/core/dependency-observable"
|
||||
*/ /** */
|
||||
|
||||
import { Observable, EventData } from "../../../data/observable";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/date-picker"
|
||||
*
|
||||
* Contains the DatePicker class.
|
||||
* @module "ui/date-picker"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
3
tns-core-modules/ui/dialogs/dialogs.d.ts
vendored
3
tns-core-modules/ui/dialogs/dialogs.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/dialogs"
|
||||
*
|
||||
* Allows you to show different dialogs such as alerts, prompts, etc.
|
||||
* @module "ui/dialogs"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
3
tns-core-modules/ui/frame/frame.d.ts
vendored
3
tns-core-modules/ui/frame/frame.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/frame"
|
||||
*
|
||||
* Contains the Frame class, which represents the logical View unit that is responsible for navigation within an application.
|
||||
* @module "ui/frame"
|
||||
*/ /** */
|
||||
|
||||
import { Page, View, Observable, EventData } from "../page";
|
||||
|
3
tns-core-modules/ui/gestures/gestures.d.ts
vendored
3
tns-core-modules/ui/gestures/gestures.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/gestures"
|
||||
*
|
||||
* Contains the GesturesObserver class, which lets you observe and respond to user gestures.
|
||||
* @module "ui/gestures"
|
||||
*/ /** */
|
||||
|
||||
import { View, EventData } from "../core/view";
|
||||
|
3
tns-core-modules/ui/html-view/html-view.d.ts
vendored
3
tns-core-modules/ui/html-view/html-view.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/html-view"
|
||||
*
|
||||
* Contains the HtmlView class, which represents a standard html view widget.
|
||||
* @module "ui/html-view"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/image-cache"
|
||||
*
|
||||
* Contains the Cache class, which handles image download requests and caches the already downloaded images.
|
||||
* @module "ui/image-cache"
|
||||
*/ /** */
|
||||
|
||||
import * as observable from "../../data/observable";
|
||||
|
3
tns-core-modules/ui/image/image.d.ts
vendored
3
tns-core-modules/ui/image/image.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/image"
|
||||
*
|
||||
* Contains the Image class, which represents an image widget.
|
||||
* @module "ui/image"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property, InheritedCssProperty, Color, Style } from "../core/view";
|
||||
|
3
tns-core-modules/ui/label/label.d.ts
vendored
3
tns-core-modules/ui/label/label.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/label"
|
||||
*
|
||||
* Contains the Label class, which represents a standard label widget.
|
||||
* @module "ui/label"
|
||||
*/ /** */
|
||||
|
||||
import { TextBase } from "../text-base";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/list-picker"
|
||||
*
|
||||
* Contains the ListPicker class.
|
||||
* @module "ui/list-picker"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
3
tns-core-modules/ui/list-view/list-view.d.ts
vendored
3
tns-core-modules/ui/list-view/list-view.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/list-view"
|
||||
*
|
||||
* Contains the ListView class, which represents a standard list view widget.
|
||||
* @module "ui/list-view"
|
||||
*/ /** */
|
||||
|
||||
import { EventData, View, Template, KeyedTemplate, Length, Property, CssProperty, Color, Style } from "../core/view";
|
||||
|
3
tns-core-modules/ui/page/page.d.ts
vendored
3
tns-core-modules/ui/page/page.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/page"
|
||||
*
|
||||
* Contains the Page class, which represents a logical unit for navigation inside a Frame.
|
||||
* @module "ui/page"
|
||||
*/ /** */
|
||||
|
||||
///<reference path="../../tns-core-modules.d.ts" /> Include global typings
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/placeholder"
|
||||
*
|
||||
* Contains the Placeholder class, which is used to add a native view to the visual tree.
|
||||
* @module "ui/placeholder"
|
||||
*/ /** */
|
||||
|
||||
import { View, EventData } from "../core/view";
|
||||
|
3
tns-core-modules/ui/progress/progress.d.ts
vendored
3
tns-core-modules/ui/progress/progress.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/progress"
|
||||
*
|
||||
* Contains the Progress class, which represents a component capable of showing progress.
|
||||
* @module "ui/progress"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
3
tns-core-modules/ui/repeater/repeater.d.ts
vendored
3
tns-core-modules/ui/repeater/repeater.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/repeater"
|
||||
*
|
||||
* Contains the Repeater class, which represents a UI Repeater component.
|
||||
* @module "ui/repeater"
|
||||
*/ /** */
|
||||
|
||||
import { LayoutBase, CustomLayoutView, Template, Property } from "../layouts/layout-base";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/scroll-view"
|
||||
*
|
||||
* Contains the ScrollView class, which represents a scrollable area that can have content that is larger than its bounds.
|
||||
* @module "ui/scroll-view"
|
||||
*/ /** */
|
||||
|
||||
import { ContentView, EventData, Property } from "../content-view";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/search-bar"
|
||||
*
|
||||
* Contains the SearchBar class, which represents a standard search bar component.
|
||||
* @module "ui/search-bar"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property, EventData, Color } from "../core/view";
|
||||
|
3
tns-core-modules/ui/slider/slider.d.ts
vendored
3
tns-core-modules/ui/slider/slider.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/slider"
|
||||
*
|
||||
* Contains the Slider class, which represents a standard slider component.
|
||||
* @module "ui/slider"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property, CoercibleProperty } from "../core/view";
|
||||
|
3
tns-core-modules/ui/switch/switch.d.ts
vendored
3
tns-core-modules/ui/switch/switch.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/switch"
|
||||
*
|
||||
* Contains the Switch class, which represents a standard switch component.
|
||||
* @module "ui/switch"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
3
tns-core-modules/ui/tab-view/tab-view.d.ts
vendored
3
tns-core-modules/ui/tab-view/tab-view.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/tab-view"
|
||||
*
|
||||
* Contains the TabView class, which represents a standard content component with tabs.
|
||||
* @module "ui/tab-view"
|
||||
*/ /** */
|
||||
|
||||
import { View, ViewBase, Property, CssProperty, Style, EventData, Color } from "../core/view";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/text-base"
|
||||
*
|
||||
* Contains the TextField class, which represents an editable single-line box.
|
||||
* @module "ui/text-base"
|
||||
*/ /** */
|
||||
|
||||
import { EditableTextBase, Property } from "../editable-text-base";
|
||||
|
3
tns-core-modules/ui/text-view/text-view.d.ts
vendored
3
tns-core-modules/ui/text-view/text-view.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/text-view"
|
||||
*
|
||||
* Contains the TextView class, which represents an editable multi-line line box.
|
||||
* @module "ui/text-view"
|
||||
*/ /** */
|
||||
|
||||
import { EditableTextBase } from "../editable-text-base";
|
||||
|
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/time-picker"
|
||||
*
|
||||
* Contains the TimePicker class.
|
||||
* @module "ui/time-picker"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property } from "../core/view";
|
||||
|
3
tns-core-modules/ui/web-view/web-view.d.ts
vendored
3
tns-core-modules/ui/web-view/web-view.d.ts
vendored
@ -1,7 +1,6 @@
|
||||
/**
|
||||
* @module "ui/transition"
|
||||
*
|
||||
* Contains the WebView class, which represents a standard browser widget.
|
||||
* @module "ui/transition"
|
||||
*/ /** */
|
||||
|
||||
import { View, Property, EventData } from "../core/view";
|
||||
|
2
tns-core-modules/xml/xml.d.ts
vendored
2
tns-core-modules/xml/xml.d.ts
vendored
@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @module "xml"
|
||||
* Contains the XmlParser class, which is a SAX parser using the easysax implementation.
|
||||
* @module "xml"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
|
Reference in New Issue
Block a user