dany/antos-frontend
1
0
Fork 0
mirror of https://github.com/lxsang/antos-frontend.git synced 2024-11-16 01:38:21 +01:00
Code Issues 1 Actions Projects Releases Wiki Activity

fix: doc generation use latest typedoc version
All checks were successful
gitea-sync/antos/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
DanyLE 2023-05-30 13:08:30 +02:00
parent edbbc9f248
commit 1db1b11277
24 changed files with 135 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Jenkinsfile vendored
View File

@ -22,11 +22,13 @@ pipeline{
steps { steps {
sh''' sh'''
cd $WORKSPACE cd $WORKSPACE
[ -d "$WORKSPACE/node_modules" ] && rm -rf "$WORKSPACE/node_modules" || true
npm install terser npm install terser
npm install uglifycss npm install uglifycss
npm install typescript npm install typescript
npm install @types/jquery npm install @types/jquery
npm i typedoc@0.19.0 npm i typedoc@0.24
npm i typedoc-plugin-merge-modules
buildir="build" buildir="build"
[ -d "$buildir" ] && rm -rf "$buildir" [ -d "$buildir" ] && rm -rf "$buildir"
export BUILDDIR="$WORKSPACE/$buildir/opt/www/htdocs/os" export BUILDDIR="$WORKSPACE/$buildir/opt/www/htdocs/os"

6
Makefile
View File

@ -227,8 +227,10 @@ ar:
release: main uglify release: main uglify
.PHONY: doc release clean .PHONY: doc release clean
doc: doc:
# npm i typedoc@0.19.0 # npm install typedoc --save-dev
./node_modules/.bin/typedoc --mode file --excludeNotExported --hideGenerator --name "AntOS $(VERSION)-$(BRANCH)-$(BUILDID) API" --out $(DOCDIR) # npm install typedoc-plugin-merge-modules --save-dev
# ./node_modules/.bin/typedoc --mode file --excludeNotExported --hideGenerator --name "AntOS $(VERSION)-$(BRANCH)-$(BUILDID) API" --out $(DOCDIR)
./node_modules/.bin/typedoc --hideGenerator --plugin typedoc-plugin-merge-modules --entryPointStrategy expand --name "AntOS $(VERSION)-$(BRANCH)-$(BUILDID) API" --out $(DOCDIR)
test: build_javascripts test: build_javascripts
jest jest

2
src/core/Announcerment.ts
View File

@ -132,7 +132,7 @@ namespace OS {
export class Announcer { export class Announcer {
/** /**
* The observable object that stores event name * The observable object that stores event name
* and its corresponding callback in [[ObservableEntryType]] * and its corresponding callback in {@link ObservableEntryType}
* *
* @type {GenericObject<ObservableEntryType>} * @type {GenericObject<ObservableEntryType>}
* @memberof Announcer * @memberof Announcer

6
src/core/BaseApplication.ts
View File

@ -422,7 +422,7 @@ namespace OS {
* Base menu definition. This function * Base menu definition. This function
* returns the based menu definition of all applications. * returns the based menu definition of all applications.
* Other application specific menu entries * Other application specific menu entries
* should be defined in [[menu]] function * should be defined in {@link menu} function
* *
* @protected * @protected
* @returns {GUI.BasicItemType[]} * @returns {GUI.BasicItemType[]}
@ -469,7 +469,7 @@ namespace OS {
* Show local toast notification * Show local toast notification
* *
* @param {any} data to send * @param {any} data to send
* @param {GUI.ToastOptions} notification options see [[GUI.ToastOptions]] * @param {GUI.ToastOptions} notification options see {@link GUI.ToastOptions}
* @returns {void} * @returns {void}
* @memberof BaseApplication * @memberof BaseApplication
*/ */
@ -495,7 +495,7 @@ namespace OS {
} }
/** /**
* The cleanup function that is called by [[onexit]] function. * The cleanup function that is called by {@link onexit} function.
* Application need to override this function to perform some * Application need to override this function to perform some
* specific task before exiting or to prevent the application * specific task before exiting or to prevent the application
* to be exited * to be exited

8
src/core/BaseDialog.ts
View File

@ -250,7 +250,7 @@ namespace OS {
/** /**
* If the `markup` variable is not provided, then * If the `markup` variable is not provided, then
* the [[init]] function will find the scheme definition * the {@link init} function will find the scheme definition
* in this class variable * in this class variable
* *
* @static * @static
@ -420,10 +420,10 @@ namespace OS {
`; `;
/** /**
* A text dialog is similar to a [[PromptDialog]] nut allows * A text dialog is similar to a {@link PromptDialog} nut allows
* user to input multi-line text. * user to input multi-line text.
* *
* Refer to [[PromptDialog]] for the definition of input and callback data * Refer to {@link PromptDialog} for the definition of input and callback data
* of the dialog * of the dialog
* *
* @export * @export
@ -565,7 +565,7 @@ namespace OS {
* title: string // window title * title: string // window title
* } * }
* ``` * ```
* Callback data: [[ColorType]] object * Callback data: {@link ColorType} object
* *
* @export * @export
* @class ColorPickerDialog * @class ColorPickerDialog

6
src/core/BaseModel.ts
View File

@ -155,7 +155,7 @@ namespace OS {
* to handle all local events inside that model. * to handle all local events inside that model.
* *
* This observable object is propagate to all the * This observable object is propagate to all the
* UI elements ([[AFXTag]]) inside the model * UI elements ({@link OS.GUI.AFXTag}) inside the model
* *
* @protected * @protected
* @type {API.Announcer} * @type {API.Announcer}
@ -579,10 +579,10 @@ namespace OS {
} }
/** /**
* Open a [[YesNoDialog]] to confirm a task * Open a {@link OS.GUI.dialogs.YesNoDialog} to confirm a task
* *
* @protected * @protected
* @param {GenericObject<any>} data [[YesNoDialog]] input data * @param {GenericObject<any>} data {@link OS.GUI.dialogs.YesNoDialog} input data
* @returns {Promise<boolean>} * @returns {Promise<boolean>}
* @memberof BaseModel * @memberof BaseModel
*/ */

2
src/core/BaseService.ts
View File

@ -71,7 +71,7 @@ namespace OS {
/** /**
* Reference to the timer that periodically executes the callback * Reference to the timer that periodically executes the callback
* defined in [[watch]]. * defined in {@link watch}.
* *
* @private * @private
* @type {number} * @type {number}

50
src/core/core.ts
View File

@ -39,8 +39,8 @@ interface String {
/** /**
* Parse the current string and convert it * Parse the current string and convert it
* to an object of type [[Version]] if the string * to an object of type {@link OS.Version} if the string
* is in the format recognized by [[Version]], * is in the format recognized by {@link OS.Version},
* e.g.: `1.0.1-a` * e.g.: `1.0.1-a`
* *
* @returns {OS.Version} * @returns {OS.Version}
@ -98,7 +98,7 @@ interface String {
format(...args: any[]): string; format(...args: any[]): string;
/** /**
* Create a [[FormattedString]] object using the current * Create a {@link OS.FormattedString} object using the current
* string and the input parameters * string and the input parameters
* *
* @param {...any[]} args * @param {...any[]} args
@ -178,7 +178,7 @@ interface Array<T> {
/** /**
* Extend the Data prototype with the * Extend the Data prototype with the
* [[timestamp]] function * {@link timestamp} function
* *
* @interface Date * @interface Date
*/ */
@ -210,7 +210,7 @@ interface GenericObject<T> {
} }
/** /**
* Global function to create a [[FormattedString]] from * Global function to create a {@link OS.FormattedString} from
* a formatted string and a list of parameters. Example * a formatted string and a list of parameters. Example
* *
* ```typescript * ```typescript
@ -305,7 +305,7 @@ namespace OS {
/** /**
* The value of the format pattern represented * The value of the format pattern represented
* in [[fs]] * in {@link fs}
* *
* @type {any[]} * @type {any[]}
* @memberof FormattedString * @memberof FormattedString
@ -812,13 +812,13 @@ namespace OS {
/** /**
* Variable represents the current AntOS version, it * Variable represents the current AntOS version, it
* is an instance of [[Version]] * is an instance of {@link OS.Version}
*/ */
export const VERSION: Version = new Version(undefined); export const VERSION: Version = new Version(undefined);
/** /**
* Variable represents the current AntOS source code repository * Variable represents the current AntOS source code repository
* is an instance of [[string]] * is an instance of string
*/ */
export const REPOSITORY: string = "https://github.com/lxsang/antos"; export const REPOSITORY: string = "https://github.com/lxsang/antos";
@ -829,10 +829,10 @@ namespace OS {
/** /**
* Register a model prototype to the system namespace. * Register a model prototype to the system namespace.
* There are two types of model to be registered, if the model * There are two types of model to be registered, if the model
* is of type [[SubWindow]], its prototype will be registered * is of type {@link OS.GUI.SubWindow}, its prototype will be registered
* in the [[dialogs]] namespace, otherwise, if the model type * in the {@link OS.GUI.dialogs} namespace, otherwise, if the model type
* is [[Application]] or [[Service]], its prototype will be * is {@link OS.application.BaseApplication} or {@link OS.application.BaseService}, its prototype will be
* registered in the [[application]] namespace. * registered in the {@link application} namespace.
* *
* When a model is loaded in the system, its prototype is registered * When a model is loaded in the system, its prototype is registered
* for later uses * for later uses
@ -886,7 +886,7 @@ namespace OS {
/** /**
* Booting up AntOS. This function checks whether the user * Booting up AntOS. This function checks whether the user
* is successfully logged in, then call [[startAntOS]], otherwise * is successfully logged in, then call {@link OS.GUI.startAntOS}, otherwise
* it shows the login screen * it shows the login screen
* *
* @export * @export
@ -919,7 +919,7 @@ namespace OS {
/** /**
* Perform the system shutdown operation. This function calls all * Perform the system shutdown operation. This function calls all
* clean up handles in [[cleanupHandles]], then save the system setting * clean up handles in {@link cleanupHandles}, then save the system setting
* before exiting * before exiting
* *
* @export * @export
@ -941,7 +941,7 @@ namespace OS {
} }
/** /**
* Register a callback to the system [[cleanupHandles]] * Register a callback to the system {@link cleanupHandles}
* *
* @export * @export
* @param {string} n callback string name * @param {string} n callback string name
@ -979,7 +979,7 @@ namespace OS {
export interface PackageMetaType { export interface PackageMetaType {
/** /**
* The application class name, if the package has only services * The application class name, if the package has only services
* this property is ignored and [[pkgname]] should be specified * this property is ignored and {@link pkgname} should be specified
* *
* @type {string} * @type {string}
* @memberof PackageMetaType * @memberof PackageMetaType
@ -987,7 +987,7 @@ namespace OS {
app?: string; app?: string;
/** /**
* Package name, in case of [[app]] being undefined, this property * Package name, in case of {@link app} being undefined, this property
* need to be specified * need to be specified
* *
* @type {string} * @type {string}
@ -1126,7 +1126,7 @@ namespace OS {
/** /**
* Package version, should be in a format conforming * Package version, should be in a format conforming
* to the version definition in [[Version]] class * to the version definition in {@link Version} class
* *
* @type {string} * @type {string}
* @memberof PackageMetaType * @memberof PackageMetaType
@ -1183,7 +1183,7 @@ namespace OS {
export var lang: GenericObject<string> = {}; export var lang: GenericObject<string> = {};
/** /**
* Re-export the system announcement [[getMID]] function to the * Re-export the system announcement {@link OS.announcer.getMID} function to the
* core API * core API
* *
* @export * @export
@ -1343,7 +1343,7 @@ namespace OS {
* beginning of a heavy task * beginning of a heavy task
* *
* @export * @export
* @param {number} q message id, see [[mid]] * @param {number} q message id, see {@link mid}
* @param {string} p message string * @param {string} p message string
*/ */
export function loading(q: number, p: string): void { export function loading(q: number, p: string): void {
@ -1526,8 +1526,8 @@ namespace OS {
* Fetch the package meta-data from the server * Fetch the package meta-data from the server
* *
* @export * @export
* @returns {Promise<RequestResult>} Promise on a [[RequestResult]]. * @returns {Promise<RequestResult>} Promise on a {@link RequestResult}.
* A success request result should contain a list of [[PackageMetaType]] * A success request result should contain a list of {@link PackageMetaType}
*/ */
export function fetch(): Promise<RequestResult> { export function fetch(): Promise<RequestResult> {
return API.handle.packages({ return API.handle.packages({
@ -1573,7 +1573,7 @@ namespace OS {
* Save the current user setting * Save the current user setting
* *
* @export * @export
* @returns {Promise<RequestResult>} promise on a [[RequestResult]] * @returns {Promise<RequestResult>} promise on a {@link RequestResult}
*/ */
export function setting(): Promise<RequestResult> { export function setting(): Promise<RequestResult> {
return API.handle.setting(); return API.handle.setting();
@ -1619,7 +1619,7 @@ namespace OS {
* text in spotlight. * text in spotlight.
* *
* This function will call all the search handles stored * This function will call all the search handles stored
* in [[searchHandle]] and build the search result based * in {@link searchHandle} and build the search result based
* on output of these handle * on output of these handle
* *
* @export * @export
@ -1644,7 +1644,7 @@ namespace OS {
} }
/** /**
* Register a search handle to the global [[searchHandle]] * Register a search handle to the global {@link searchHandle}
* *
* @export * @export
* @param {string} name handle name string * @param {string} name handle name string

18
src/core/gui.ts
View File

@ -108,7 +108,7 @@ namespace OS {
/** /**
* Item children, usually used by tree view or menu item * Item children, usually used by tree view or menu item
* This property is keep for compatibility purposes only. * This property is keep for compatibility purposes only.
* Otherwise, the [[nodes]] property should be used * Otherwise, the {@link nodes} property should be used
* *
* @type {BasicItemType[]} * @type {BasicItemType[]}
* @memberof BasicItemType * @memberof BasicItemType
@ -146,7 +146,7 @@ namespace OS {
* UI elements, then insert this UI scheme to the DOM tree. * UI elements, then insert this UI scheme to the DOM tree.
* *
* This function renders the UI of the application before calling the * This function renders the UI of the application before calling the
* application's [[main]] function * application's `main` function
* *
* @export * @export
* @param {string} html html scheme string * @param {string} html html scheme string
@ -174,7 +174,7 @@ namespace OS {
/** /**
* Load an application scheme file then render * Load an application scheme file then render
* it with [[htmlToScheme]] * it with {@link htmlToScheme}
* *
* @export * @export
* @param {string} path VFS path to the scheme file * @param {string} path VFS path to the scheme file
@ -294,7 +294,7 @@ namespace OS {
*/ */
export interface ToastOptions { export interface ToastOptions {
/** /**
* Where the Toast is displayed? see [[ANCHOR]] * Where the Toast is displayed? see {@link ANCHOR}
* *
* @type {ANCHOR} * @type {ANCHOR}
* @memberof ToastOptions * @memberof ToastOptions
@ -322,7 +322,7 @@ namespace OS {
/** /**
* Toast notification API * Toast notification API
* Show a toast message on different posisition on screen, see [[ToastOptions]] * Show a toast message on different posisition on screen, see {@link ToastOptions}
* *
* @export * @export
* @param * @param
@ -516,7 +516,7 @@ namespace OS {
/** /**
* Kill an running processes of an application, then * Kill an running processes of an application, then
* unregister the application prototype definition * unregister the application prototype definition
* from the [[application]] namespace. * from the {@link application} namespace.
* *
* This process is similar to uninstall the application * This process is similar to uninstall the application
* from the current system state * from the current system state
@ -569,7 +569,7 @@ namespace OS {
* in the system. * in the system.
* *
* This function fist loads and registers the application prototype * This function fist loads and registers the application prototype
* definition in the [[application]] namespace, then update * definition in the {@link application} namespace, then update
* the system packages meta-data * the system packages meta-data
* *
* First it tries to load the package with the app name is also the * First it tries to load the package with the app name is also the
@ -861,7 +861,7 @@ namespace OS {
* Bind a context menu event to an AntOS element. * Bind a context menu event to an AntOS element.
* *
* This will find the fist element which defines a handle * This will find the fist element which defines a handle
* named [[contextMenuHandle]] and bind the context menu * named {@link contextMenuHandle} and bind the context menu
* event to it. * event to it.
* *
* @param {JQuery.MouseEventBase} event mouse event * @param {JQuery.MouseEventBase} event mouse event
@ -1091,7 +1091,7 @@ namespace OS {
/** /**
* Show the login screen and perform the login operation. * Show the login screen and perform the login operation.
* *
* Once login successfully, the [[startAntOS]] will be called * Once login successfully, the {@link startAntOS} will be called
* *
* @export * @export
*/ */

34
src/core/handles/RemoteHandle.ts
View File

@ -158,7 +158,7 @@ namespace OS {
* *
* @export * @export
* @param {string} p a VFS file path e.g. home://test/ * @param {string} p a VFS file path e.g. home://test/
* @returns {Promise<RequestResult>} A promise on a [[RequestResult]] * @returns {Promise<RequestResult>} A promise on a {@link RequestResult}
* which contains an error or a list of FileInfoType * which contains an error or a list of FileInfoType
*/ */
export function scandir(p: string): Promise<RequestResult> { export function scandir(p: string): Promise<RequestResult> {
@ -203,7 +203,7 @@ namespace OS {
* *
* @export * @export
* @param {string} p VFS file path * @param {string} p VFS file path
* @returns {Promise<RequestResult>} A promise on a [[RequestResult]] * @returns {Promise<RequestResult>} A promise on a {@link RequestResult}
* which contains an error or an object of FileInfoType * which contains an error or an object of FileInfoType
*/ */
export function fileinfo(p: string): Promise<RequestResult> { export function fileinfo(p: string): Promise<RequestResult> {
@ -226,8 +226,8 @@ namespace OS {
* - xml, html: the response is a XML/HTML object * - xml, html: the response is a XML/HTML object
* - text: plain text * - text: plain text
* *
* @returns {Promise<any>} A promise on a [[RequestResult]] * @returns {Promise<any>} A promise on a {@link RequestResult}
* which contains an error or an object of [[FileInfoType]] * which contains an error or an object of {@link FileInfoType}
*/ */
export function readfile(p: string, t: string): Promise<any> { export function readfile(p: string, t: string): Promise<any> {
const path = `${API.REST}/VFS/get/`; const path = `${API.REST}/VFS/get/`;
@ -240,7 +240,7 @@ namespace OS {
* @export * @export
* @param {string} s VFS source file path * @param {string} s VFS source file path
* @param {string} d VFS destination file path * @param {string} d VFS destination file path
* @returns {Promise<RequestResult>} A promise on a [[RequestResult]] * @returns {Promise<RequestResult>} A promise on a {@link RequestResult}
* which contains an error or a success response * which contains an error or a success response
*/ */
export function move(s: string, d: string): Promise<RequestResult> { export function move(s: string, d: string): Promise<RequestResult> {
@ -253,7 +253,7 @@ namespace OS {
* *
* @export * @export
* @param {string} p VFS file path * @param {string} p VFS file path
* @returns {Promise<RequestResult>} A promise on a [[RequestResult]] * @returns {Promise<RequestResult>} A promise on a {@link RequestResult}
* which contains an error or a success response * which contains an error or a success response
*/ */
export function remove(p: string): Promise<RequestResult> { export function remove(p: string): Promise<RequestResult> {
@ -278,7 +278,7 @@ namespace OS {
* *
* @export * @export
* @param {PackageCommandType} d a package command of type PackageCommandType * @param {PackageCommandType} d a package command of type PackageCommandType
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] * @returns {Promise<RequestResult>} a promise on a {@link RequestResult}
*/ */
export function packages( export function packages(
d: PackageCommandType d: PackageCommandType
@ -292,7 +292,7 @@ namespace OS {
* *
* @export * @export
* @param {string} d VFS destination directory path * @param {string} d VFS destination directory path
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] * @returns {Promise<RequestResult>} a promise on a {@link RequestResult}
*/ */
export function upload(d: string): Promise<RequestResult> { export function upload(d: string): Promise<RequestResult> {
const path = `${API.REST}/VFS/upload`; const path = `${API.REST}/VFS/upload`;
@ -305,7 +305,7 @@ namespace OS {
* @export * @export
* @param {string} p path to the VFS file * @param {string} p path to the VFS file
* @param {string} d file data encoded in Base 64 * @param {string} d file data encoded in Base 64
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] * @returns {Promise<RequestResult>} a promise on a {@link RequestResult}
*/ */
export function write( export function write(
p: string, p: string,
@ -371,8 +371,8 @@ namespace OS {
* Check if a user is logged in * Check if a user is logged in
* *
* @export * @export
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] that * @returns {Promise<RequestResult>} a promise on a {@link RequestResult} that
* contains an error or a [[UserSettingType]] object * contains an error or a {@link OS.setting.UserSettingType} object
*/ */
export function auth(): Promise<RequestResult> { export function auth(): Promise<RequestResult> {
const p = `${API.REST}/user/auth`; const p = `${API.REST}/user/auth`;
@ -383,9 +383,9 @@ namespace OS {
* Perform a login operation * Perform a login operation
* *
* @export * @export
* @param {UserLoginType} d user data [[UserLoginType]] * @param {UserLoginType} d user data {@link UserLoginType}
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] that * @returns {Promise<RequestResult>} a promise on a {@link RequestResult} that
* contains an error or a [[UserSettingType]] object * contains an error or a {@link OS.setting.UserSettingType} object
*/ */
export function login(d: UserLoginType): Promise<RequestResult> { export function login(d: UserLoginType): Promise<RequestResult> {
const p = `${API.REST}/user/login`; const p = `${API.REST}/user/login`;
@ -396,7 +396,7 @@ namespace OS {
* Perform a logout operation * Perform a logout operation
* *
* @export * @export
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] * @returns {Promise<RequestResult>} a promise on a {@link RequestResult}
*/ */
export function logout(): Promise<RequestResult> { export function logout(): Promise<RequestResult> {
const p = `${API.REST}/user/logout`; const p = `${API.REST}/user/logout`;
@ -407,7 +407,7 @@ namespace OS {
* Save the current user settings * Save the current user settings
* *
* @export * @export
* @returns {Promise<RequestResult>} a promise on a [[RequestResult]] * @returns {Promise<RequestResult>} a promise on a {@link RequestResult}
*/ */
export function setting(): Promise<RequestResult> { export function setting(): Promise<RequestResult> {
const p = `${API.REST}/system/settings`; const p = `${API.REST}/system/settings`;
@ -440,7 +440,7 @@ namespace OS {
* ``` * ```
* { table: "table name", cond: [conditional object]} * { table: "table name", cond: [conditional object]}
* ``` * ```
* @returns {Promise<RequestResult>} a promise of [[RequestResult]] on the * @returns {Promise<RequestResult>} a promise of {@link RequestResult} on the
* query data * query data
* *
* A conditional object represents a SQL condition statement as an object, * A conditional object represents a SQL condition statement as an object,

2
src/core/pm.ts
View File

@ -11,7 +11,7 @@ namespace OS {
| application.BaseApplication | application.BaseApplication
| application.BaseService; | application.BaseService;
/** /**
* Alias to all classes that extends [[BaseModel]] * Alias to all classes that extends {@link BaseModel}
*/ */
export type ModelTypeClass = { export type ModelTypeClass = {
new <T extends BaseModel>(args: AppArgumentsType[]): T; new <T extends BaseModel>(args: AppArgumentsType[]): T;

2
src/core/settings.ts
View File

@ -308,7 +308,7 @@ namespace OS {
/** /**
* Package repositories setting. * Package repositories setting.
* This configuration is used by [[MarketPlace]] * This configuration is used by {@link OS.application.MarketPlace}
* for package management * for package management
* *
* @type {{ * @type {{

2
src/core/tags/CalendarTag.ts
View File

@ -140,7 +140,7 @@ namespace OS {
* This function triggers the date select event * This function triggers the date select event
* *
* @private * @private
* @param {TagEventType} e AFX tag event data [[TagEventType]] * @param {TagEventType} e AFX tag event data {@link TagEventType}
* @returns {void} * @returns {void}
* @memberof CalendarTag * @memberof CalendarTag
*/ */

12
src/core/tags/FileViewTag.ts
View File

@ -167,7 +167,7 @@ namespace OS {
/** /**
* set the function that allows to fetch file entries. * set the function that allows to fetch file entries.
* This handle function should return a promise on * This handle function should return a promise on
* an arry of [[API.FileInfoType]] * an arry of {@link API.FileInfoType}
* *
* @memberof FileViewTag * @memberof FileViewTag
*/ */
@ -178,7 +178,7 @@ namespace OS {
/** /**
* set the callback handle for the file select event. * set the callback handle for the file select event.
* The parameter of the callback should be an object * The parameter of the callback should be an object
* of type [[TagEventType]]<T> with the data type `T` is [[API.FileInfoType]] * of type {@link TagEventType}<T> with the data type `T` is {@link API.FileInfoType}
* *
* @memberof FileViewTag * @memberof FileViewTag
*/ */
@ -189,7 +189,7 @@ namespace OS {
/** /**
* set the callback handle for the directory changed event. * set the callback handle for the directory changed event.
* The parameter of the callback should be an object * The parameter of the callback should be an object
* of type [[TagEventType]]<T> with the data type `T` is [[API.VFS.BaseFileHandle]] * of type {@link TagEventType}<T> with the data type `T` is {@link API.VFS.BaseFileHandle}
* *
* @memberof FileViewTag * @memberof FileViewTag
*/ */
@ -200,7 +200,7 @@ namespace OS {
/** /**
set the callback handle for the file open event. set the callback handle for the file open event.
* The parameter of the callback should be an object * The parameter of the callback should be an object
* of type [[TagEventType]]<T> with the data type `T` is [[API.FileInfoType]] * of type {@link TagEventType}<T> with the data type `T` is {@link API.FileInfoType}
* *
* @memberof FileViewTag * @memberof FileViewTag
*/ */
@ -235,7 +235,7 @@ namespace OS {
* *
* Turn on/off the changing current working directory feature * Turn on/off the changing current working directory feature
* of the widget when a directory is double clicked. If enabled, * of the widget when a directory is double clicked. If enabled,
* the widget will use the configured [[fetch]] function to query * the widget will use the configured {@link fetch} function to query
* the content of the selected directory * the content of the selected directory
* *
* Getter: * Getter:
@ -346,7 +346,7 @@ namespace OS {
* *
* Set the path of the current working directory. * Set the path of the current working directory.
* When called the widget will refresh the current * When called the widget will refresh the current
* working directory using the configured [[fetch]] * working directory using the configured {@link fetch}
* function * function
* *
* Getter: * Getter:

8
src/core/tags/GridViewTag.ts
View File

@ -229,7 +229,7 @@ namespace OS {
* Setter: * Setter:
* *
* Set the data of the cell, this will trigger * Set the data of the cell, this will trigger
* the [[ondatachange]] function * the {@link ondatachange} function
* *
* Getter: * Getter:
* *
@ -255,7 +255,7 @@ namespace OS {
* Setter: * Setter:
* *
* Set/unset the current cell as selected. * Set/unset the current cell as selected.
* This will trigger the [[cellselect]] * This will trigger the {@link cellselect}
* event * event
* *
* Getter: * Getter:
@ -345,7 +345,7 @@ namespace OS {
/** /**
* Simple grid cell defines a grid cell with * Simple grid cell defines a grid cell with
* an [[LabelTag]] as it cell layout * an {@link LabelTag} as it cell layout
* *
* @export * @export
* @class SimpleGridCellTag * @class SimpleGridCellTag
@ -390,7 +390,7 @@ namespace OS {
protected calibrate(): void { } protected calibrate(): void { }
/** /**
* The layout of the cell with a simple [[LabelTag]] * The layout of the cell with a simple {@link LabelTag}
* *
* @returns * @returns
* @memberof SimpleGridCellTag * @memberof SimpleGridCellTag

10
src/core/tags/ListViewTag.ts
View File

@ -6,7 +6,7 @@ namespace OS {
*/ */
export type ListItemEventData = TagEventDataType<ListViewItemTag>; export type ListItemEventData = TagEventDataType<ListViewItemTag>;
/** /**
* A list item represent the individual view of an item in the [[ListView]]. * A list item represent the individual view of an item in the {@link OS.GUI.tag.ListViewTag}.
* This class is an abstract prototype class, implementation of any * This class is an abstract prototype class, implementation of any
* list view item should extend it * list view item should extend it
* *
@ -197,7 +197,7 @@ namespace OS {
* Layout definition of the item tag. * Layout definition of the item tag.
* This function define the outer layout of the item. * This function define the outer layout of the item.
* Custom inner layout of each item implementation should * Custom inner layout of each item implementation should
* be defined in [[itemlayout]] * be defined in {@link itemlayout}
* *
* @protected * @protected
* @returns {TagLayoutType[]} * @returns {TagLayoutType[]}
@ -228,7 +228,7 @@ namespace OS {
* Setter: * Setter:
* *
* Set the data of the list item. This will * Set the data of the list item. This will
* trigger the [[ondatachange]] function * trigger the {@link ondatachange} function
* *
* Getter: * Getter:
* *
@ -523,7 +523,7 @@ namespace OS {
/** /**
* A collection of selected items in the list. * A collection of selected items in the list.
* The maximum size of this collection is 1 if * The maximum size of this collection is 1 if
* the [[multiselect]] feature is disabled * the {@link multiselect} feature is disabled
* *
* @private * @private
* @type {ListViewItemTag[]} * @type {ListViewItemTag[]}
@ -742,7 +742,7 @@ namespace OS {
* Button layout allows to add some custom * Button layout allows to add some custom
* behaviors to the list. * behaviors to the list.
* *
* Each button data should define the [[onbtclick]] * Each button data should define the {@link OS.GUI.tag.ButtonTag.onbtclick}
* event handle to specify the custom behavior * event handle to specify the custom behavior
* *
* When the list is configured as dropdown. The buttons * When the list is configured as dropdown. The buttons

2
src/core/tags/OverlayTag.ts
View File

@ -3,7 +3,7 @@ namespace OS {
export namespace tag { export namespace tag {
/** /**
* An overlay tag is a layout tag that alway stay on top of * An overlay tag is a layout tag that alway stay on top of
* the virtual desktop environment. Tile layout elements ([[VBoxTag]], [[HboxTag]]) * the virtual desktop environment. Tile layout elements ({@link OS.GUI.tag.VBoxTag}, {@link OS.GUI.tag.HBoxTag})
* can be used inside this tag to compose elements * can be used inside this tag to compose elements
* *
* @export * @export

6
src/core/tags/ResizerTag.ts
View File

@ -3,7 +3,7 @@ namespace OS {
export namespace tag { export namespace tag {
/** /**
* A `resizer` tag is basically used to dynamically resize an element using mouse. * A `resizer` tag is basically used to dynamically resize an element using mouse.
* It is usually put inside a [[TileLayoutTag]] an can be attached to any element. Example: * It is usually put inside a {@link TileLayoutTag} an can be attached to any element. Example:
* *
* The resizer tag in the following example will be attached to the first `afx-vbox`, * The resizer tag in the following example will be attached to the first `afx-vbox`,
* and allows to resize this element using mouse * and allows to resize this element using mouse
@ -41,8 +41,8 @@ namespace OS {
/** /**
* Reference to the parent tag of the current tag. * Reference to the parent tag of the current tag.
* The parent tag should be an instance of a [[TileLayoutTag]] * The parent tag should be an instance of a {@link TileLayoutTag}
* such as [[VBoxTag]] or [[HBoxTag]] * such as {@link VBoxTag} or {@link HBoxTag}
* *
* @private * @private
* @type {*} * @type {*}

2
src/core/tags/StackPanelTag.ts
View File

@ -4,7 +4,7 @@ namespace OS {
/** /**
* A stack pannel allows to navigate back and forth between pannels * A stack pannel allows to navigate back and forth between pannels
* (container widget). Each container widget in the stack should be * (container widget). Each container widget in the stack should be
* composed inside a [[HBoxTag]] * composed inside a {@link HBoxTag}
* *
* *
* @export * @export

4
src/core/tags/TabContainerTag.ts
View File

@ -19,9 +19,9 @@ namespace OS {
} }
export namespace tag { export namespace tag {
/** /**
* A tab container allows to attach each tab on a [[TabBarTag]] * A tab container allows to attach each tab on a {@link TabBarTag}
* with a container widget. The attached container widget should be * with a container widget. The attached container widget should be
* composed inside a [[HBoxTag]] * composed inside a {@link HBoxTag}
* *
* The tab bar in a tab container can be configured to display tabs * The tab bar in a tab container can be configured to display tabs
* in horizontal (row) or vertical (column) order. Default to vertical order * in horizontal (row) or vertical (column) order. Default to vertical order

12
src/core/tags/TreeViewTag.ts
View File

@ -111,7 +111,7 @@ namespace OS {
* Placeholder for the `fetch` function of the node. * Placeholder for the `fetch` function of the node.
* This function is used to fetch the child nodes of the * This function is used to fetch the child nodes of the
* current nodes. This function should return a promise on * current nodes. This function should return a promise on
* a list of [[TreeViewDataType]] * a list of {@link TreeViewDataType}
* *
* @memberof TreeViewItemPrototype * @memberof TreeViewItemPrototype
*/ */
@ -164,7 +164,7 @@ namespace OS {
* Setter: * Setter:
* *
* Set the data of the current node. This will trigger the * Set the data of the current node. This will trigger the
* [[ondatachange]] function * {@link ondatachange} function
* *
* Getter: * Getter:
* *
@ -405,7 +405,7 @@ namespace OS {
* Layout definition of a node. This function * Layout definition of a node. This function
* returns the definition of the base outer layout * returns the definition of the base outer layout
* of a node. Custom inner layout of the node should * of a node. Custom inner layout of the node should
* be defined in the [[itemlayout]] function * be defined in the {@link itemlayout} function
* *
* @protected * @protected
* @returns {TagLayoutType[]} * @returns {TagLayoutType[]}
@ -464,8 +464,8 @@ namespace OS {
} }
/** /**
* SimpleTreeViewItem extends [[TreeViewItemPrototype]] and * SimpleTreeViewItem extends {@link TreeViewItemPrototype} and
* define it inner layout using a [[LabelTag]] * define it inner layout using a {@link LabelTag}
* *
* @export * @export
* @class SimpleTreeViewItem * @class SimpleTreeViewItem
@ -641,7 +641,7 @@ namespace OS {
* Placeholder for the `fetch` function of the tree. * Placeholder for the `fetch` function of the tree.
* This function is used to fetch the child nodes of the * This function is used to fetch the child nodes of the
* current tree. This function should return a promise on * current tree. This function should return a promise on
* a list of [[TreeViewDataType]] * a list of {@link TreeViewDataType}
* *
* @memberof TreeViewTag * @memberof TreeViewTag
*/ */

18
src/core/tags/tag.ts
View File

@ -24,7 +24,7 @@ interface HTMLElement {
* defined on any child of this element will be ignored. * defined on any child of this element will be ignored.
* *
* @param {JQuery.MouseEventBase} e a mouse event * @param {JQuery.MouseEventBase} e a mouse event
* @param {OS.GUI.tag.StackMenuTag} m The context menu element [[StackMenuTag]] * @param {OS.GUI.tag.StackMenuTag} m The context menu element {@link OS.GUI.tag.StackMenuTag}
* @memberof HTMLElement * @memberof HTMLElement
*/ */
contextmenuHandle(e: JQuery.MouseEventBase, m: OS.GUI.tag.StackMenuTag): void; contextmenuHandle(e: JQuery.MouseEventBase, m: OS.GUI.tag.StackMenuTag): void;
@ -69,7 +69,7 @@ interface HTMLElement {
enable_drag(): void; enable_drag(): void;
/** /**
* Perform DOM generation ([[afxml]]) then mount ([[sync]]) all the * Perform DOM generation ({@link afxml}) then mount ({@link sync}) all the
* elements. * elements.
* *
* @param {OS.API.Announcer} o an AntOS observable object * @param {OS.API.Announcer} o an AntOS observable object
@ -116,7 +116,7 @@ interface Document {
namespace OS { namespace OS {
export namespace GUI { export namespace GUI {
/** /**
* [[TagLayoutType]] interface using by AFX tags to defined * TagLayoutType interface using by AFX tags to defined
* its internal DOM hierarchy * its internal DOM hierarchy
* *
* @export * @export
@ -157,7 +157,7 @@ namespace OS {
/** /**
* this is the `data-id` attribute of the element, * this is the `data-id` attribute of the element,
* can be query by the [[aid]] Tag API function. * can be query by the {@link OS.GUI.AFXTag.aid} Tag API function.
* Not to be confused with the DOM `id` attribute * Not to be confused with the DOM `id` attribute
* *
* @type {(string | number)} * @type {(string | number)}
@ -294,7 +294,7 @@ namespace OS {
* Reference to some of the tag's children * Reference to some of the tag's children
* element. This reference object is built * element. This reference object is built
* based on the `ref` property found in the * based on the `ref` property found in the
* tag layout [[TagLayoutType]] * tag layout {@link TagLayoutType}
* *
* @protected * @protected
* @type {GenericObject<HTMLElement>} * @type {GenericObject<HTMLElement>}
@ -487,7 +487,7 @@ namespace OS {
/** /**
* Init the current tag, this function * Init the current tag, this function
* is called before the [[mount]] function * is called before the {@link mount} function
* *
* @protected * @protected
* @abstract * @abstract
@ -516,7 +516,7 @@ namespace OS {
/** /**
* Update only the current tag, this function is * Update only the current tag, this function is
* called by [[update]] before chaining the * called by {@link update} before chaining the
* update process to its children * update process to its children
* *
* @protected * @protected
@ -707,7 +707,7 @@ namespace OS {
*/ */
export namespace tag { export namespace tag {
/** /**
* Alias to all classes that extends [[AFXTag]] * Alias to all classes that extends {@link AFXTag}
*/ */
export type AFXTagTypeClass = { export type AFXTagTypeClass = {
new <T extends AFXTag>(): T; new <T extends AFXTag>(): T;
@ -719,7 +719,7 @@ namespace OS {
* new definition * new definition
* *
* @export * @export
* @template T all classes that extends [[AFXTag]] * @template T all classes that extends {@link AFXTag}
* @param {string} name name of the tag * @param {string} name name of the tag
* @param {{ new (): T }} cls the class that defines the tag * @param {{ new (): T }} cls the class that defines the tag
* @returns {void} * @returns {void}

44
src/core/vfs.ts
View File

@ -21,7 +21,7 @@ interface String {
* Convert a string to VFS file handle. * Convert a string to VFS file handle.
* *
* This function will create a file handle object from the string * This function will create a file handle object from the string
* with the help of [[VFS.findHandles]] * with the help of {@link OS.API.VFS.findHandles}
* *
* @returns {OS.API.VFS.BaseFileHandle} * @returns {OS.API.VFS.BaseFileHandle}
* @memberof String * @memberof String
@ -226,7 +226,7 @@ namespace OS {
* *
* When converting a string to file handle, the system will look * When converting a string to file handle, the system will look
* for a protocol pattern in the string, if the protocol found, * for a protocol pattern in the string, if the protocol found,
* its attached handle class (found in [[VFS.handles]]) will be * its attached handle class (found in {@link VFS.handles}) will be
* used to initialize a file handle object from the string * used to initialize a file handle object from the string
* *
* ```typescript * ```typescript
@ -322,7 +322,7 @@ namespace OS {
basename: string; basename: string;
/** /**
* Once loaded, [[ready]] will be set to true and * Once loaded, {@link ready} will be set to true and
* file meta-data will be stored in this place holder * file meta-data will be stored in this place holder
* *
* @type {FileInfoType} * @type {FileInfoType}
@ -569,7 +569,7 @@ namespace OS {
/** /**
* Public read operation * Public read operation
* *
* This function calls the [[_rd]] function to perform the operation. * This function calls the {@link _rd} function to perform the operation.
* *
* If the current file is a directory, then the operation * If the current file is a directory, then the operation
* will return the meta-data of all files inside of the directory. * will return the meta-data of all files inside of the directory.
@ -601,7 +601,7 @@ namespace OS {
/** /**
* Write the file cache to the actual file * Write the file cache to the actual file
* *
* This function calls the [[_wr]] function to perform the operation * This function calls the {@link _wr} function to perform the operation
* *
* @param {string} t data type * @param {string} t data type
* - `base64` * - `base64`
@ -626,7 +626,7 @@ namespace OS {
/** /**
* Sub-directory creation * Sub-directory creation
* *
* This function calls the [[_mk]] function to perform the operation * This function calls the {@link _mk} function to perform the operation
* *
* @param {string} d sub directory name * @param {string} d sub directory name
* @returns {Promise<RequestResult>} promise on the operation result * @returns {Promise<RequestResult>} promise on the operation result
@ -648,7 +648,7 @@ namespace OS {
/** /**
* Delete the file * Delete the file
* *
* This function calls the [[_rm]] function to perform the operation * This function calls the {@link _rm} function to perform the operation
* @param {any} d user data * @param {any} d user data
* @returns {Promise<RequestResult>} promise on the operation result * @returns {Promise<RequestResult>} promise on the operation result
* @memberof BaseFileHandle * @memberof BaseFileHandle
@ -671,7 +671,7 @@ namespace OS {
* *
* Only work when the current file is a directory * Only work when the current file is a directory
* *
* This function calls the [[_up]] function to perform the operation * This function calls the {@link _up} function to perform the operation
* *
* @returns {Promise<RequestResult>} promise on the operation result * @returns {Promise<RequestResult>} promise on the operation result
* @memberof BaseFileHandle * @memberof BaseFileHandle
@ -694,7 +694,7 @@ namespace OS {
* *
* Only work with file * Only work with file
* *
* This function calls the [[_pub]] function to perform the operation * This function calls the {@link _pub} function to perform the operation
* *
* @returns {Promise<RequestResult>} promise on operation result * @returns {Promise<RequestResult>} promise on operation result
* @memberof BaseFileHandle * @memberof BaseFileHandle
@ -717,7 +717,7 @@ namespace OS {
* *
* Only work with file * Only work with file
* *
* This function calls the [[_down]] function to perform the operation * This function calls the {@link _down} function to perform the operation
* *
* @returns {Promise<any>} Promise on the operation result * @returns {Promise<any>} Promise on the operation result
* @memberof BaseFileHandle * @memberof BaseFileHandle
@ -738,7 +738,7 @@ namespace OS {
/** /**
* Move the current file to another location * Move the current file to another location
* *
* This function calls the [[_mv]] function to perform the operation * This function calls the {@link _mv} function to perform the operation
* *
* @param {string} d destination location * @param {string} d destination location
* @returns {Promise<RequestResult>} promise on the operation result * @returns {Promise<RequestResult>} promise on the operation result
@ -763,7 +763,7 @@ namespace OS {
* *
* This action depends on each file protocol * This action depends on each file protocol
* *
* This function calls the [[_exec]] function to perform the operation * This function calls the {@link _exec} function to perform the operation
* *
* @returns {Promise<any>} * @returns {Promise<any>}
* @memberof BaseFileHandle * @memberof BaseFileHandle
@ -831,7 +831,7 @@ namespace OS {
* that supports the operation * that supports the operation
* *
* @protected * @protected
* @param {any} t data type, see [[read]] * @param {any} t data type, see {@link read}
* @returns {Promise<RequestResult>} * @returns {Promise<RequestResult>}
* @memberof BaseFileHandle * @memberof BaseFileHandle
*/ */
@ -846,7 +846,7 @@ namespace OS {
* that supports the operation * that supports the operation
* *
* @protected * @protected
* @param {string} t data type, see [[write]] * @param {string} t data type, see {@link write}
* @returns {Promise<RequestResult>} * @returns {Promise<RequestResult>}
* @memberof BaseFileHandle * @memberof BaseFileHandle
*/ */
@ -1025,7 +1025,7 @@ namespace OS {
* Otherwise, file content will be returned * Otherwise, file content will be returned
* *
* @protected * @protected
* @param {string} t data type see [[read]] * @param {string} t data type see {@link read}
* @returns {Promise<any>} * @returns {Promise<any>}
* @memberof RemoteFileHandle * @memberof RemoteFileHandle
*/ */
@ -1057,7 +1057,7 @@ namespace OS {
* Write file cache to the remote file * Write file cache to the remote file
* *
* @protected * @protected
* @param {string} t data type see [[write]] * @param {string} t data type see {@link write}
* @returns {Promise<RequestResult>} * @returns {Promise<RequestResult>}
* @memberof RemoteFileHandle * @memberof RemoteFileHandle
*/ */
@ -1293,7 +1293,7 @@ namespace OS {
/** /**
* Package file is remote file ([[RemoteFileHandle]]) located either in * Package file is remote file ({@link RemoteFileHandle}) located either in
* the local user packages location or system packages * the local user packages location or system packages
* location, it should be in the following format: * location, it should be in the following format:
* *
@ -1596,7 +1596,7 @@ namespace OS {
* Read file content stored in the file cached * Read file content stored in the file cached
* *
* @protected * @protected
* @param {string} t data type see [[read]] * @param {string} t data type see {@link read}
* @returns {Promise<any>} * @returns {Promise<any>}
* @memberof BufferFileHandle * @memberof BufferFileHandle
*/ */
@ -1617,7 +1617,7 @@ namespace OS {
* Write data to the file cache * Write data to the file cache
* *
* @protected * @protected
* @param {string} t data type, see [[write]] * @param {string} t data type, see {@link write}
* @returns {Promise<RequestResult>} * @returns {Promise<RequestResult>}
* @memberof BufferFileHandle * @memberof BufferFileHandle
*/ */
@ -1801,7 +1801,7 @@ namespace OS {
* Read URL content * Read URL content
* *
* @protected * @protected
* @param {string} t data type see [[read]] * @param {string} t data type see {@link read}
* @returns {Promise<any>} * @returns {Promise<any>}
* @memberof URLFileHandle * @memberof URLFileHandle
*/ */
@ -1855,7 +1855,7 @@ namespace OS {
* Read file content * Read file content
* *
* @protected * @protected
* @param {string} t data type, see [[read]] * @param {string} t data type, see {@link read}
* @returns {Promise<any>} * @returns {Promise<any>}
* @memberof SharedFileHandle * @memberof SharedFileHandle
*/ */
@ -1874,7 +1874,7 @@ namespace OS {
* write data to shared file * write data to shared file
* *
* @protected * @protected
* @param {string} t data type, see [[write]] * @param {string} t data type, see {@link write}
* @returns {Promise<RequestResult>} * @returns {Promise<RequestResult>}
* @memberof SharedFileHandle * @memberof SharedFileHandle
*/ */

3
tsconfig.json
View File

@ -8,5 +8,8 @@
], ],
"outDir": "dist" "outDir": "dist"
}, },
"typedocOptions": {
"entryPoints": ["src"]
},
"include": ["src/**/*.ts"] "include": ["src/**/*.ts"]
} }