Skip to content

Commit

Permalink
Adding docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
siokas committed Apr 13, 2020
1 parent ad84645 commit 0047448
Show file tree
Hide file tree
Showing 12 changed files with 737 additions and 112 deletions.
43 changes: 0 additions & 43 deletions AppDetailAccessors.ts

This file was deleted.

123 changes: 123 additions & 0 deletions AppDetails.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
import { AppDetailsAccessors } from "./interfaces.ts";

/**
* Accessors of the app name, description and version.
*
* @export default
* @class AppDetailAccessors
*/
export default class AppDetails implements AppDetailsAccessors {
/**
* The name of the app.
*
* @public
* @type {string}
* @memberof AppDetails
*/
_app_name: string;

/**
* The description of the app.
*
* @public
* @type {string}
* @memberof AppDetails
*/
_app_description: string;

/**
* The version of the app.
*
* @public
* @type {string}
* @memberof AppDetails
*/
_app_version: string;

/**
* Constructor of AppDetails object.
*
* @param {AppDetailsAccessors} app_details
* @memberof AppDetails
*/
constructor(app_details?: AppDetailsAccessors) {
if (app_details) {
this._app_name = app_details.app_name;
this._app_description = app_details.app_description;
this._app_version = app_details.app_version;
} else {
this._app_name = "My App";
this._app_description = "My Description";
this._app_version = "0.0.1";
}
}

/**
* Getter of the app name
*
* @public
* @return {string}
* @memberof AppDetails
*/
get app_name(): string {
return this._app_name;
}

/**
* Setter of the app name
*
* @public
* @param {string} name
* @return void
* @memberof AppDetails
*/
set app_name(name: string) {
this._app_name = name;
}

/**
* Getter of the app description
*
* @public
* @return {string}
* @memberof AppDetails
*/
get app_description(): string {
return this._app_description;
}

/**
* Setter of the app description
*
* @public
* @param {string} description
* @return void
* @memberof AppDetails
*/
set app_description(description: string) {
this._app_description = description;
}

/**
* Getter of the app version
*
* @public
* @return {string}
* @memberof AppDetails
*/
get app_version(): string {
return this._app_version;
}

/**
* Setter of the app version
*
* @public
* @param {string} version
* @return void
* @memberof AppDetails
*/
set app_version(version: string) {
this._app_version = version;
}
}
Loading

0 comments on commit 0047448

Please sign in to comment.