javascript/NativeScript
1
0
Fork 0
mirror of https://github.com/NativeScript/NativeScript.git synced 2025-08-17 04:33:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

Integrated the documentation build in the bcl build.

Browse Source
This commit is contained in:
PanayotCankov
2014-06-03 16:56:09 +03:00
parent 0f6ae75f56
commit 676c965bb9
9 changed files with 69 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
BCL.csproj
View File

@ -340,7 +340,8 @@
<Exec Condition=" '$(Configuration)' == 'Documentation' " Command='rd /q /s "../../Documentation/Docs/"' />
<Exec Condition=" '$(Configuration)' == 'Documentation' " Command='md "../../Documentation/Docs/"' />
<!-- Add to Docs in the ../../Documentation/ folder -> node Src/SnippetsExtractor/app.js -source ..\JS\BCL\bin\Documentation\Tests -destination Snippets -->
<Exec Condition=" '$(Configuration)' == 'Documentation' " Command='node ../../Documentation/Src/SnippetsExtractor/app.js -noclean -source bin\Documentation\Tests -destination ../../Documentation/Docs/' />
<Exec Condition=" '$(Configuration)' == 'Documentation' " Command="node ../../Documentation/Src/TypeScriptAPIExtractor/app.js @(TypeScriptCompile) $(IntermediateOutputPath)\api.xml" IgnoreExitCode="true" IgnoreStandardErrorWarningFormat="false" LogStandardErrorAsError="true" />
<Exec Condition=" '$(Configuration)' == 'Documentation' " Command='"../../Documentation/Src/XMLAPIPrinting/bin/Release/XMLAPIPrinting.exe" $(IntermediateOutputPath)\api.xml "../../Documentation/Docs/"' />

6
Tests/application-tests-common.ts
View File

@ -1,4 +1,4 @@
// <snippet name="application">
// <snippet name="application/HOW-TO">
// # Application
// The Application module provides abstraction over the platform-specific Application implementations.
// It is the main BCL module and is required for other BCL modules to work properly.
@ -9,7 +9,7 @@ import app = require("application");
// The pre-required `app` module is used throughout the following code snippets.
// </snippet>
// <snippet name="application">
// <snippet name="application/HOW-TO">
// ### Initialization
// ``` JavaScript
//// The native app instance depends on the target platform
@ -18,7 +18,7 @@ app.init(nativeAppInstance);
// ```
// </snippet>
// <snippet name="application">
// <snippet name="application/HOW-TO">
// ### Checking the target platform
// Use the following code in case you need to check somewhere in your code the platform you are running against:
// ``` JavaScript

2
Tests/application-tests.android.ts
View File

@ -6,7 +6,7 @@ import commonTests = require("Tests/application-tests-common");
declare var exports;
require("utils/module-merge").merge(commonTests, exports);
// <snippet name="application">
// <snippet name="application/HOW-TO">
// ### Using the Android-specific implementation
// Accessing the Android-specific object instance (will be undefined if running on iOS)
// ``` JavaScript

54
Tests/file-system-tests.ts
View File

@ -1,5 +1,5 @@

// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// # File System
// Using the file system requires the FileSystem module.
// ``` JavaScript
@ -10,12 +10,12 @@ import fs = require("file-system");
import TKUnit = require("Tests/TKUnit");
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ## Path
// </snippet>
export var testPathNormalize = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Normalize a Path
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -31,7 +31,7 @@ export var testPathNormalize = function () {
};
export var testPathJoin = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Path Join
// Concatinate a path to a file by providing multiple path arguments.
// ``` JavaScript
@ -47,7 +47,7 @@ export var testPathJoin = function () {
};
export var testPathSeparator = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Get the Path Separator
// ``` JavaScript
//// An OS dependant path separator, "\" or "/".
@ -61,7 +61,7 @@ export var testPathSeparator = function () {
};
export var testFileFromPath = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Get or Create a File With Path
// The following example writes some text to a file created for path.
// It will create a new file or overwrite an existing file.
@ -98,7 +98,7 @@ export var testFileFromPath = function () {
}
export var testFolderFromPath = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Get or Create a Folder With Path
// ``` JavaScript
var path = fs.path.join(fs.knownFolders.documents().path, "music");
@ -112,12 +112,12 @@ export var testFolderFromPath = function () {
// </snippet>
}
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ## Create
// </snippet>
export var testFileWrite = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Writing a string to a File
// The following example writes some text to a file.
// It will create a new file or overwrite an existing file.
@ -153,7 +153,7 @@ export var testFileWrite = function () {
};
export var testGetFile = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Get or Create a File
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -168,7 +168,7 @@ export var testGetFile = function () {
}
export var testGetFolder = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Get or Create a Folder
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -182,12 +182,12 @@ export var testGetFolder = function () {
// </snippet>
};
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ## Read
// </snippet>
export var testFileRead = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Reading from a File
// The following example writes some text to a file and then reads it back.
// ``` JavaScript
@ -230,7 +230,7 @@ export var testFileRead = function () {
};
export var testGetKnownFolders = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Getting the Known Folders
// Each app has several well known folders. This is how to access them:
// ``` JavaScript
@ -251,7 +251,7 @@ export var testGetKnownFolders = function () {
};
export var testGetEntities = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Getting Folder Contents
// Getting all files and folders within a folder:
// ``` JavaScript
@ -300,7 +300,7 @@ export var testGetEntities = function () {
};
export var testEnumEntities = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Enumerating Folder Contents
// Getting all folder entities in array may be slow with large number of files.
// Enumerating the folder entities would itterate the files one by one without blocking the UI.
@ -338,7 +338,7 @@ export var testEnumEntities = function () {
};
export var testGetParent = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Getting Parent Folder
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -357,7 +357,7 @@ export var testGetParent = function () {
};
export var testFileNameExtension = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Getting File Name and Extension
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -376,7 +376,7 @@ export var testFileNameExtension = function () {
};
export var testFileExists = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Checking if a File Exists
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -393,7 +393,7 @@ export var testFileExists = function () {
};
export var testFolderExists = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Checking if a Folder Exists
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -419,12 +419,12 @@ export var testContainsFile = function () {
file.remove();
};
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ## Update
// </snippet>
export var testFileRename = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Renaming a File
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -450,7 +450,7 @@ export var testFileRename = function () {
};
export var testFolderRename = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Renaming a Folder
// ``` JavaScript
var folder = fs.knownFolders.documents();
@ -475,12 +475,12 @@ export var testFolderRename = function () {
// </snippet>
};
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ## Delete
// </snippet>
export var testFileRemove = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Removing a File
// To 'delete', 'remove' or 'unlink' a file use the file's remove method:
// ``` JavaScript
@ -504,7 +504,7 @@ export var testFileRemove = function () {
};
export var testFolderRemove = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Removing a Folder
// ``` JavaScript
var documents = fs.knownFolders.documents();
@ -528,7 +528,7 @@ export var testFolderRemove = function () {
}
export var testFolderClear = function () {
// <snippet name="file-system">
// <snippet name="file-system/HOW-TO">
// ### Clearing the Contents of a Folder
// The clear method removes all files within a folder.
// ``` JavaScript

14
Tests/http-tests.ts
View File

@ -2,7 +2,7 @@
import http = require("http");
require("globals");
// <snippet name="http">
// <snippet name="http/HOW-TO">
// # Http module
// ``` JavaScript
// var http = require("http");
@ -18,7 +18,7 @@ export var test_getString = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get string from URL
// ``` JavaScript
http.getString("http://httpbin.org/get").then(function (r) {
@ -61,7 +61,7 @@ export var test_getJSON = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get JSON from URL
// ``` JavaScript
http.getJSON("http://httpbin.org/get").then(function (r) {
@ -104,7 +104,7 @@ export var test_getImage = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get Image from URL
// ``` JavaScript
http.getImage("http://www.google.com/images/errors/logo_sm_2.png").then(function (r) {
@ -161,7 +161,7 @@ export var test_request_responseStatusCodeShouldBeDefined = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get response status code
// ``` JavaScript
http.request({ url: "http://httpbin.org/get", method: "GET" }).then(function (response) {
@ -187,7 +187,7 @@ export var test_request_responseHeadersShouldBeDefined = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get response headers
// ``` JavaScript
http.request({ url: "http://httpbin.org/get", method: "GET" }).then(function (response) {
@ -215,7 +215,7 @@ export var test_request_responseContentShouldBeDefined = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="http">
// <snippet name="http/HOW-TO">
// ### Get response content
// ``` JavaScript
http.request({ url: "http://httpbin.org/get", method: "GET" }).then(function (response) {

10
Tests/image-source-tests.ts
View File

@ -1,4 +1,4 @@
// <snippet name="image-source">
// <snippet name="image-source/HOW-TO">
// # Image source
// Using the image source requires the image-source module.
// ``` JavaScript
@ -18,7 +18,7 @@ import app = require("application");
import TKUnit = require("Tests/TKUnit");
export var testFromResource = function () {
// <snippet name="image-source">
// <snippet name="image-source/HOW-TO">
// ### Load image using resource name
// This is similar to loading Bitmap from `R.drawable.logo` on Android or calling `[UIImage imageNamed@"logo"]` on iOS
// ``` JavaScript
@ -32,7 +32,7 @@ export var testFromUrl = function () {
var completed;
var result: imageSource.ImageSource;
// <snippet name="image-source">
// <snippet name="image-source/HOW-TO">
// ### Load image from URL
// ``` JavaScript
imageSource.fromUrl("http://www.google.com/images/errors/logo_sm_2.png")
@ -62,7 +62,7 @@ export var testFromUrl = function () {
}
export var testSaveToFile = function () {
// <snippet name="image-source">
// <snippet name="image-source/HOW-TO">
// ### Save image source to PNG or JPG file
// ``` JavaScript
var img = imageSource.fromResource("logo");
@ -76,7 +76,7 @@ export var testSaveToFile = function () {
}
export var testFromFile = function () {
// <snippet name="image-source">
// <snippet name="image-source/HOW-TO">
// ### Load image from a local file
// ``` JavaScript
var folder = fs.knownFolders.documents();

20
Tests/local-settings-tests.ts
View File

@ -1,4 +1,4 @@
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// # Local Settings
// ``` JavaScript
var LocalSettings = require("local-settings");
@ -13,7 +13,7 @@ var noStringKey: string = "noStringKey";
var noBoolKey: string = "noBoolKey";
var noNumberKey: string = "noNumberKey";
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ## Working with string, number and boolean values
// </snippet>
@ -22,7 +22,7 @@ export var testBoolean = function () {
var boolValue = LocalSettings.getBoolean(boolKey);
TKUnit.assert(false == boolValue, "Cannot set boolean to false, currently it is: " + LocalSettings.getBoolean(boolKey));
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Set and get boolean value and provide default value in case it is not set
// ``` JavaScript
LocalSettings.setBoolean("boolKey", true);
@ -35,7 +35,7 @@ export var testBoolean = function () {
};
export var testString = function () {
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Set and get string value
// ``` JavaScript
LocalSettings.setString("stringKey", "String value");
@ -46,7 +46,7 @@ export var testString = function () {
};
export var testNumber = function () {
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Set and get numeric value.
// We use `toFixed()` here in order to avoid floating point errors - ex: `54.321` becoming `54.320999999537`.
// Beware the result of `toFixed()` is a string not a number therefore you cannot use `===` or `!==` when comparing with a number.
@ -59,7 +59,7 @@ export var testNumber = function () {
};
export var testDefaults = function () {
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Reading values that are not set before while providing default value
// ``` JavaScript
var defaultValue = LocalSettings.getString("noStringKey", "No string value");
@ -70,7 +70,7 @@ export var testDefaults = function () {
TKUnit.assert(true === LocalSettings.getBoolean(noBoolKey, true), "Bad default boolean value");
TKUnit.assert(123.45 === LocalSettings.getNumber(noNumberKey, 123.45), "Bad default number value");
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Reading values that are not set before not providing default value
// ``` JavaScript
var defaultValue = LocalSettings.getString("noStringKey");
@ -83,12 +83,12 @@ export var testDefaults = function () {
TKUnit.assert("undefined" === typeof LocalSettings.getNumber(noNumberKey), "Default number value is not undefined");
};
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ## Other functions
// </snippet>
export var testHasKey = function () {
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Checking for existence of value for key
// ``` JavaScript
var hasKey = LocalSettings.hasKey("noBoolKey");
@ -105,7 +105,7 @@ export var testHasKey = function () {
};
export var testRemove = function () {
// <snippet name="local-settings">
// <snippet name="local-settings/HOW-TO">
// ### Removing value for key
// ``` JavaScript
LocalSettings.remove("boolKey");

16
Tests/location-tests.ts
View File

@ -1,4 +1,4 @@
// <snippet name="location">
// <snippet name="location/HOW-TO">
// # Location
// Using the location requires the Location module.
// ``` JavaScript
@ -12,12 +12,12 @@ import locationModule = require("location");
var LocationManager = locationModule.LocationManager;
var Location = locationModule.Location;
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ## Other functions
// </snippet>
export var testIsEnabled = function () {
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ### Test are location services available for this device
// ``` JavaScript
var isEnabled = LocationManager.isEnabled();
@ -27,7 +27,7 @@ export var testIsEnabled = function () {
};
export var testDistance = function () {
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ### Get distance between two locations
// ``` JavaScript
//var Location = require("location").Location;
@ -43,14 +43,14 @@ export var testDistance = function () {
TKUnit.assert((distance > 10780000) && (distance < 10860000), "invalid distance " + distance);
};
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ## Getting location
// </snippet>
export var testLocation = function () {
var locationReceived;
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ### Receive continuous location updates
// ``` JavaScript
var locationManager = new LocationManager();
@ -83,7 +83,7 @@ export var testLocation = function () {
export var testLastKnownLocation = function () {
TKUnit.waitUntilReady(function () { return false; }, 1); // give it some time after the last test
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ### Get last known location
// ``` JavaScript
var locationManager = new LocationManager();
@ -135,7 +135,7 @@ export var testLocationOnceTimeout10000 = function () {
export var testSnippet = function () {
var locationReceived;
// <snippet name="location">
// <snippet name="location/HOW-TO">
// ### Get location once
// if there is `options.timeout` you will receive error on timeout. If `options.timeout` is 0 then the result is the same as the result from `LocationManager.lastKnownLocation`
// and there will be no wait. You can use `options.maximumAge` to specify you don't want to receive locations older than specified time in ms.

12
Tests/timer-tests.ts
View File

@ -1,7 +1,7 @@
import TKUnit = require("Tests/TKUnit");
var timer = require("timer/timer");
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// # Timer module
// ``` JavaScript
// require("globals");
@ -30,7 +30,7 @@ export var test_setTimeout = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// ### Evaluates an expression after 0 milliseconds.
// ``` JavaScript
timer.setTimeout(function () {
@ -49,7 +49,7 @@ export var test_setTimeout_callbackCalledAfterSpecifedTime = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// ### Evaluates an expression after a specified number of milliseconds.
// ``` JavaScript
timer.setTimeout(function () {
@ -85,7 +85,7 @@ export var test_setTimeout_callbackShouldBeCleared = function () {
var completed: boolean;
var isReady = function () { return completed; }
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// ### Cancels the evaluation with the clearTimeout method.
// ``` JavaScript
var id = timer.setTimeout(function () {
@ -109,7 +109,7 @@ export var test_setInterval_callbackCalledDuringPeriod = function () {
var expected = 4;
var isReady = function () { return counter >= expected; }
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// ### Evaluates an expression each time a specified number of milliseconds has elapsed.
// ``` JavaScript
timer.setInterval(function () {
@ -129,7 +129,7 @@ export var test_setInterval_callbackShouldBeCleared = function () {
var expected = 1;
var isReady = function () { return counter == expected; }
// <snippet name="timer">
// <snippet name="timer/HOW-TO">
// ### Cancel the interval previously started using the setInterval method.
// ``` JavaScript
var id = timer.setInterval(function () {