Changeset 1069 for library/bdm/mex

Show
Ignore:
Timestamp:
06/09/10 19:36:07 (14 years ago)
Author:
mido
Message:

documentation of loggers updated

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/bdm/mex/mex_logger.h

    r1064 r1069  
    4242} 
    4343 
    44 //! Logger storing results into an mxArray 
     44//! \brief Logger storing results into an mxArray 
    4545class mexlog : public memlog { 
    4646public: 
     
    7474        return tmp; 
    7575    } 
    76     void from_setting ( const Setting &root ) { 
    77         maxlen = root["maxlen"]; 
     76 
     77    /*! Create object from the following structure 
     78 
     79    \code 
     80    class = 'mexlog';     
     81    maxlen = [];               % size of memory buffer 
     82    \endcode 
     83    */ 
     84    void from_setting ( const Setting &set ) { 
     85        UI::get ( maxlen,  set, "maxlen", UI::compulsory ); 
    7886    } 
     87 
    7988    Config& _setting_conf() { 
    8089        return setting_conf;