Method plist/setDescriptionForParam


  SETDESCRIPTIONFORPARAM Sets the property 'desc' of the param object in dependencies of the 'key'
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: Sets the property 'desc' of the param object in dependencies
               of the 'key'
 
  CALL:        obj = obj.setDescriptionForParam('key', 'description for the key');
               obj = obj.setDescriptionForParam(plist('key', 'key', 'desc', 'description for the key'));
               obj = setDescriptionForParam(obj, 'key', 'description for the key');
 
  INPUTS:      obj - can be a vector, matrix, list, or a mix of them.
               pl  - to set the description of a key with a plist, please
                     specify only one plist with the key-words 'key' and
                     'desc'
 
  Parameters Description
 
  VERSION:     $Id: setDescriptionForParam.m,v 1.7 2011/04/08 08:56:21 hewitson Exp $
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class plist
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
KEY '' none The key of the parameter to set the description for.
DESC '' none The description to set.
back to top back to top

Some information of the method plist/setDescriptionForParam are listed below:
Class name plist
Method name setDescriptionForParam
Category Helper
CVS Version $Id: setDescriptionForParam.m,v 1.7 2011/04/08 08:56:21 hewitson Exp $
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team