Changeset 659

Timestamp:

10/13/09 17:36:56 (15 years ago)

Author:

mido

Message:

synchronization of documentation pages names

Location:

library

Files:

• bdm/base/user_info.h (modified) (10 diffs)
• doc/tutorial/005userguide0.dox (modified) (3 diffs)
• doc/tutorial/01userguide.dox (modified) (2 diffs)
• doc/tutorial/02userguide2.dox (modified) (2 diffs)
• doc/tutorial/03devguide.dox (modified) (1 diff)
• doc/tutorial/04devguide2.dox (modified) (1 diff)
• doc/tutorial/arx_ui.dox (modified) (1 diff)
• doc/tutorial/mexfiles.dox (modified) (1 diff)
• doc/tutorial/ui.dox (modified) (1 diff)

library/bdm/base/user_info.h

@@ -3 +3 @@
   \brief UI (user info) class for loading/saving objects from/to configuration files.
   It is designed with use of libconfig C/C++ Configuration File Library
-  \ref ui_page
+  \ref ui
   \author Vaclav Smidl.
 
@@ -36 +36 @@
 //! Generic exception for reporting configuration errors
 //!
-//!  \ref ui_page
+//!  \ref ui
 class UIException : public std::exception {
 private:
@@ -68 +68 @@
 //! Exception for reporting configuration errors related to some concrete Setting path
 //!
-//!  \ref ui_page
+//!  \ref ui
 class UISettingException : public UIException {
 public:
@@ -86 +86 @@
 //! Exception for reporting configuration errors in the "class" attribute
 //!
-//!  \ref ui_page
+//!  \ref ui
 class UIClassException : public UIException {
 public:
@@ -124 +124 @@
 \endcode
 
-\ref ui_page
+\ref ui
 */
 class UIFile : public Config {
@@ -205 +205 @@
 that the #result Setting reference is valid within the scope of SettingResolver instance.
 
-\ref ui_page
+\ref ui
  */
 class SettingResolver : root {
@@ -238 +238 @@
 descendant ParticularUI<T>.
 
-\ref ui_page
+\ref ui
 */
 class UI {
@@ -579 +579 @@
 
 //! The only UI descendant class which is not intended for direct use. It should be accessed within the UIREGISTER macro only.
-//! \ref ui_page
+//! \ref ui
 template<typename T> class ParticularUI : private UI {
 public:
@@ -600 +600 @@
   This macro should be used in header file, immediately after a class declaration.
 
-  \ref ui_page
+  \ref ui
 */
 #ifndef BDMLIB
@@ -617 +617 @@
   Technical meann of registering UIREGISTER(class_name<template_name>).
 
-  \ref ui_page
+  \ref ui
  */
 #ifndef BDMLIB

library/doc/tutorial/005userguide0.dox

@@ -1 +1 @@
 /*!
-\page user_guide0 BDM Use - Introduction
+\page userguide0 BDM Use - Introduction
 
 BDM is a library of basic components for Bayesian decision making, hence its direct use is not possible. In order to use BDM the components must be pulled together in order to achieve desired functionality. We expect two kinds of users:
@@ -24 +24 @@
 \section secnario Prepared Scenarios
 
-Since some tasks are repeatedly occuring in practical applications of decision making, these tasks has been identified and prepared as standalone applications (or mex files). These taska are implemented in separate toolbox - bdmtoolbox. Binary version of the toolbox is available see \ref instalation.
+Since some tasks are repeatedly occuring in practical applications of decision making, these tasks has been identified and prepared as standalone applications (or mex files). These taska are implemented in separate toolbox - bdmtoolbox. Binary version of the toolbox is available see \ref install.
 
 The predefined scenarios are:
@@ -35 +35 @@
 A tutorial how to run the scenarios are:
 
- - \ref user_guide
- - \ref user_guide2
+ - \ref userguide
+ - \ref userguide2
 
 */

library/doc/tutorial/01userguide.dox

@@ -1 +1 @@
 /*!
-\page user_guide BDM Use - System, Data, Simulation
-
-This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref 005userguide0 it also serves as introduction to configuration of an experiment (see \ref ui_page) and basic decision making objects (bdm::RV and bdm::DS).
+\page userguide BDM Use - System, Data, Simulation
+
+This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref 005userguide0 it also serves as introduction to configuration of an experiment (see \ref ui) and basic decision making objects (bdm::RV and bdm::DS).
 
 All experiments are demonstarted on scenario simulator which can be either standalone application or mex file (simulator.mex**).
@@ -14 +14 @@
 
 The configuration has two possible options:
- - configuration file using syntax of libconfig (see \ref ui_page),
+ - configuration file using syntax of libconfig (see \ref ui),
  - matlab structure.
 For the purpose of tutorial, we will use the matlab notation. 
-These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui_page)
+These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui)
 
 \subsection ug_first First experiment

library/doc/tutorial/02userguide2.dox

@@ -1 +1 @@
 /*!
-\page user_guide2 BDM Use - Estimation and Bayes Rule
+\page userguide2 BDM Use - Estimation and Bayes Rule
 
 Baysian theory is predominantly used in system identification, or estimation problems. 
@@ -21 +21 @@
 \li Result Logger is an object (class logger) dedicated to storing important data from the experiment.
 
-Since objects  datasource and the logger has already been introduced in section \ref user_guide, it remains to introduce 
+Since objects  datasource and the logger has already been introduced in section \ref userguide, it remains to introduce 
 object \c Bayesian \c Model (bdm::BM).
 

library/doc/tutorial/03devguide.dox

@@ -1 +1 @@
 /*!
-\page dev_guide  BDM Use - in C++ 
+\page devguide  BDM Use - in C++ 
 
 \section Intro Logic of BDM
 - \subpage intro
-- \subpage ui_page
+- \subpage ui
 - \subpage mexfiles
 

library/doc/tutorial/04devguide2.dox

@@ -1 +1 @@
 /*!
-\page dev_guide2 BDM Development - Contribution guide
+\page devguide2 BDM Development - Contribution guide
 \addindex Howto Contribute to BDM - Advanced development
 

library/doc/tutorial/arx_ui.dox

@@ -6 +6 @@
 \section cmd Command Line
 
-In order to use it for estimation of an ARX model, we can define the following \ref ui_page "user info" structure:
+In order to use it for estimation of an ARX model, we can define the following \ref ui "user info" structure:
 \include arx_test.cfg
 

library/doc/tutorial/mexfiles.dox

@@ -5 +5 @@
 
 A range of mexfiles is predefined in directory \c library/mex.
-Many of these mexfile process ui files (see \ref ui_page) examples of these files are in directory \c library/tutorial.
+Many of these mexfile process ui files (see \ref ui) examples of these files are in directory \c library/tutorial.
 Note that in order to run these files you need to let matlab know where to find them:
 \code

library/doc/tutorial/ui.dox

@@ -1 +1 @@
 /*!
-\page ui_page User Infos and their use
+\page ui User Infos and their use
  
 \sa #bdm::UI