User Tools

Site Tools


obj.help

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

obj.help [2010/06/12 21:22] (current)
jochen created
Line 1: Line 1:
 +====== obj.Help ======
 +
 +===== Motivation =====
 +This function is a means to get help on a specific method of a given object.
 +
 +===== Reference ('​obj.Help('​Help'​)'​) =====
 +<​file>​ AFT::​Help ​ - method for any xff type
 + 
 + ​FORMAT: ​      ​[helptext] = obj.Help([methodname,​ onerror]);
 + 
 + Input fields:
 + 
 +       ​methodname ​ if given, only the help for one method is returned
 +       ​onerror ​    ​checks global flag and only returns help if requested
 + 
 + ​Output fields:
 + 
 +       ​helptext ​   1xN char array describing all (or one) method(s)
 + 
 + ​TYPES:​ ALL</​file>​
 +
 +===== Usage example =====
 +<code matlab obj_Help_example.m>​% loading a protocol
 +prt = xff('​*.prt'​);​
 +
 +% getting help on the prt.CreateSDM method
 +prt.Help('​CreateSDM'​)</​code>​
  
obj.help.txt ยท Last modified: 2010/06/12 21:22 by jochen