chore(docs): Update method descriptions (#4913)

* chore(docs): Update method descriptions

* Fix grammar
This commit is contained in:
Alexander Vakrilov
2017-10-04 17:48:03 +02:00
committed by Emil Tabakov
parent 3891f3d3d2
commit cc96b67e4e

View File

@ -67,21 +67,21 @@ export function verifyCallback(value: any): void;
/** /**
* A function that gets the class name of an object. * 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. * Returns a string with the name of the class.
*/ */
export function getClass(object): string; export function getClass(object): string;
/** /**
* A function that gets the entire class hierarchy of an object. * A function that gets the entire class hierarchy of an object.
* @param object The object which class hierarchy will be get. * @param object The object.
* Return an array of strings with the name of all classes. * Returns an array of strings with the name of all base classes.
*/ */
export function getBaseClasses(object): Array<string>; export function getBaseClasses(object): Array<string>;
/** /**
* A function that gets the ClassInfo for an object. * 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. * Returns a ClassInfo for the object.
*/ */
export function getClassInfo(object: Object): ClassInfo; export function getClassInfo(object: Object): ClassInfo;
@ -102,7 +102,7 @@ export class ClassInfo {
} }
/** /**
* Returns a string representation of a string to be shown in UI. * Returns a string representation of an object to be shown in UI.
* @param object The object which class hierarchy will be get. * @param object The object.
*/ */
export function toUIString(object): string; export function toUIString(object): string;