Changeset 1063 for library/bdm/base/bdmbase.h

Timestamp:

06/09/10 11:50:16 (14 years ago)

Author:

mido

Message:

a small patch of documentation, to be contiuned..

Files:

• library/bdm/base/bdmbase.h (modified) (4 diffs)

library/bdm/base/bdmbase.h

@@ -570 +570 @@
 
   This macro has to be called within a class declaration. Its argument \a classname has to correspond to that wrapping class.
-  This macro defines a log_level instance which can be modified either directly or by the means of #UI class.
+  This macro defines a log_level instance which can be modified either directly or by the means of #bdm::UI class.
 
   One of the main purposes of this macro is to allow variability in using enumerations. By relating them to their names through
@@ -736 +736 @@
         //! log upper bound of the density (see function qbounds)
         
-        //! \var log_level_enums logfull
-        //! log full record of the density in the form of setting
         LOG_LEVEL(epdf,logmean,loglbound,logubound);
 
@@ -801 +799 @@
         //! Set statistics to match given input epdf. Typically it copies statistics from epdf of the same type and projects those form different types
         //! \param pdf0 epdf to match
-        //! \param option placeholder for potential options
         void set_statistics(const epdf *pdf0) NOT_IMPLEMENTED_VOID;
         //!@}
@@ -1309 +1306 @@
 
         /*! \brief Incremental Bayes rule
-        @param dt vector of input data
+        @param yt vector of input data
         */
         virtual void bayes ( const vec &yt, const vec &cond = empty_vec ) =0;