Skip to content

Commit d098ff4

Browse files
PanayotCankovPanayotCankov
committed
Add module names for the typedoc, make it work
Mark members with @Private for typedoc.
1 parent c590771 commit d098ff4

File tree

101 files changed

+647
-186
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+647
-186
lines changed

‎gruntfile.js‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,18 @@ module.exports = function(grunt) {
2323

2424
// Custom Functions
2525
var filterTypeScriptFiles = function(content, srcPath) {
26-
var matchRule = /^.*@private/ig;
27-
if (matchRule.test(content))
28-
{
26+
var leadingPrivate = /^.*@private/ig;
27+
if (leadingPrivate.test(content)) {
2928
return false;
3029
}
30+
31+
var blockCommentPrivate = /\/\*\*([^](?!\*\/))*@module([^](?!\*\/))*@private[^]*?\*\//g;
32+
if (blockCommentPrivate.test(content)) {
33+
return false;
34+
}
35+
3136
var processed = content;
32-
processed = processed.replace(/\/\/[\/\s]*@private((.|\s)*?)\/\/[\/\s]*@endprivate/gm, "");
37+
processed = processed.replace(/\/\/[\/\s]*@private[^]*?\/\/[\/\s]*?@endprivate/gm, "");
3338
return processed;
3439
};
3540

‎package.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
"shelljs": "^0.7.0",
2929
"time-grunt": "1.3.0",
3030
"tslint": "^4.4.2",
31-
"typedoc": "https://github.com/hdeshev/typedoc/blob/npm/typedoc-no-types.tgz?raw=true",
31+
"typedoc": "^0.5.10",
32+
"typedoc-plugin-external-module-name": "git+https://github.com/PanayotCankov/typedoc-plugin-external-module-name.git#with-js",
3233
"typescript": "~2.2.1"
3334
},
3435
"scripts": {
@@ -56,7 +57,7 @@
5657
"test-watch-android": "npm run pretest && concurrently --kill-others \"npm run tsc-tiw\" \"tns livesync android --path tests --watch\"",
5758
"test-watch-ios": "npm run pretest && concurrently --kill-others \"npm run tsc-tiw\" \"tns livesync ios --path tests --watch\"",
5859
"prepublish": "echo \"Development reminder: npm run setup\n\"",
59-
"typedoc": "typedoc --tsconfig tsconfig.typedoc.json --out bin/dist/apiref --mode file --includeDeclarations --name NativeScript --theme ./node_modules/nativescript-typedoc-theme",
60+
"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",
6061
"dev-typedoc": "npm run typedoc && cd bin/dist/apiref && http-server",
6162
"test-tsc-es2016": "npm run tsc -- -p tsconfig.public.es2016.json",
6263
"tslint": "tslint --config build/tslint.json 'tns-core-modules/**/*.ts' 'tests/**/*.ts' 'apps/**/*.ts' -e '**/node_modules/**' -e '**/platforms/**'"

‎tns-core-modules/application-settings/application-settings.d.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
/**
2+
* @module "application-settings"
3+
*
24
* Allows you to save and restore any kind of information related to your application.
3-
*/
5+
*/ /** */
6+
47
/**
58
* Checks whether such a key exists.
69
* @param key The key to check for.

‎tns-core-modules/application/application.d.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
///<reference path="../tns-core-modules.d.ts" /> Include global typings
2-
/**
1+
/**
2+
* @module "application"
3+
*
34
* Contains the application abstraction with all related methods.
4-
*/
5+
*/ /** */
6+
7+
///<reference path="../tns-core-modules.d.ts" /> Include global typings
58
import { NavigationEntry, View, Observable, EventData } from "../ui/frame";
69

710
/**

‎tns-core-modules/color/color.d.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
/**
2+
* @module "color"
3+
*
24
* Allows creating colors to be used when styling the UI.
3-
*/
5+
*/ /** */
6+
47
/**
58
* Represents a color object. Stores all color components (alpha (opacity), red, green, blue) in a [0..255] range.
69
*/

‎tns-core-modules/color/known-colors.d.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
export var AliceBlue;
1+
/**
2+
* @module "color/known-colors"
3+
*/ /** */
4+
5+
export var AliceBlue;
26
export var AntiqueWhite;
37
export var Aqua;
48
export var Aquamarine;

‎tns-core-modules/connectivity/connectivity.d.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
/**
2+
* @module "connectivity"
3+
*
24
* Contains connectivity utility methods.
3-
*/
5+
*/ /** */
6+
47
/**
58
* Gets the type of connection.
69
* Returns a value from the connectivity.connectionType enumeration.

‎tns-core-modules/css-value/reworkcss-value.d.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @module "css-value"
3+
*/ /** */
4+
15
interface CSSValue {
26
type: string;
37
string: string;

‎tns-core-modules/css/reworkcss.d.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @module "css"
3+
*/ /** */
4+
15
export interface Position {
26
start: { line: number; column: number };
37
end: { line: number; column: number };

‎tns-core-modules/data/observable-array/observable-array.d.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
2-
3-
/**
1+
/**
2+
* @module "data/observable-array"
3+
*
44
* Contains the ObservableArray class, which is capable of detecting and responding to changes of a collection of objects.
5-
*/
5+
*/ /** */
6+
7+
// Test: http://jsperf.com/array-vs-observable-array-vs-array-observe
68
import * as observable from "../observable";
79

810
/**

0 commit comments

Comments
 (0)