Skip to content

chore(docs): Update method descriptions #4913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
etabakov merged 2 commits into from
Oct 4, 2017
Merged

chore(docs): Update method descriptions #4913

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebe9f5c
chore(docs): Update method descriptions
Oct 3, 2017
7229878
Fix grammar
etabakov Oct 3, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions tns-core-modules/utils/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,21 +67,21 @@ export function verifyCallback(value: any): void;

/**
* A function that gets the class name of an object.
* @param object The object which class will be get.
* @param object The object.
* Returns a string with the name of the class.
*/
export function getClass(object): string;

/**
* A function that gets the entire class hierarchy of an object.
* @param object The object which class hierarchy will be get.
* Return an array of strings with the name of all classes.
* @param object The object.
* Returns an array of strings with the name of all base classes.
*/
export function getBaseClasses(object): Array<string>;

/**
* A function that gets the ClassInfo for an object.
* @param object The object for which the ClassInfo will be get.
* @param object The object.
* Returns a ClassInfo for the object.
*/
export function getClassInfo(object: Object): ClassInfo;
Expand All @@ -102,7 +102,7 @@ export class ClassInfo {
}

/**
* Returns a string representation of a string to be shown in UI.
* @param object The object which class hierarchy will be get.
* Returns a string representation of an object to be shown in UI.
* @param object The object.
*/
export function toUIString(object): string;