general/help/class_help.m File Reference

prints out class structure and documentation for a given classname or object More...

Go to the source code of this file.

Functions
function	class_help ( classname_or_object, verbose)
	prints out class structure and documentation for a given classname or object

---

Detailed Description

prints out class structure and documentation for a given classname or object

Definition in file class_help.m.

---

Function Documentation

function class_help	(		classname_or_object,
			verbose
	)

prints out class structure and documentation for a given classname or object

The information printed by this function includes

• classname,
• names of superclasses,
• parameters and
• methods.

Parameters:

classname_or_object	Either a string holding the class name or a class object, for which information shall be printed.
verbose	Integer triggering the amount of information which is printed. 0 - print parameter and method names, 1 - print parameter and method names (including inherited ones), 2 - print parameter and method names and their documentation strings, 3 - print parameter and method names and their documentation strings (including inherited parameters and methods).

Definition at line 1 of file class_help.m.