Changeset 600 for library/doc

Show
Ignore:
Timestamp:
09/03/09 22:12:12 (15 years ago)
Author:
mido
Message:

presun globalnich veci v RV dovnitr tridy kde byly zadefinovany jako staticke promenne
(plus drobne zacisteni dokumentace a adresarove struktury)

Location:
library/doc
Files:
3 modified

Legend:

Unmodified
Added
Removed

  • library/doc/local/library_structure.dox

    r375 r600  
    11/*! 
    2 \page library_structure Library structure >> UNDER CONSTRUCTION << 
     2\page library_structure Library structure 
    33 
    4 Here you find basic infromation about the library subdirectories. 
     4\todo it is necessary to fill in the missing descriptions of the directories below  
    55 
    6 Description of the library subdirectories 
     6Here you find infromation about the library structure. List of its  
     7subdirectories with a basic description follows: 
    78<ul> 
    8 <li> source:/system -- a directory containing ..., </li> 
    9 <li> source:/system/win32 -- a directory containing ..., </li> 
    10 <li> source:/system/linux -- a directory containing ...,</li> 
     9<li> source:/bdm -- library source codes </li> 
     10<li> source:/bdm/base -- base classes of the library </li> 
     11<li> source:/bdm/design -- ... </li> 
     12<li> source:/bdm/estim -- ... </li> 
     13<li> source:/bdm/math -- ... </li> 
     14<li> source:/bdm/mex -- ... </li> 
     15<li> source:/bdm/stat -- ... </li> 
     16<li> source:/doc -- library documantation and with some of its sources </li> 
     17<li> source:/doc/dot -- ... </li> 
     18<li> source:/doc/html -- html documentation generated automatically by Doxygen </li> 
     19<li> source:/doc/images -- ... </li> 
     20<li> source:/doc/issues -- ... </li> 
     21<li> source:/doc/latex -- latex documentation generated automatically by Doxygen </li> 
     22<li> source:/doc/local -- documentation pages which are not related to any specific source file </li> 
     23<li> source:/doc/tutorial -- documentation pages related to the library tutorial</li> 
     24<li> source:/doc/xml -- ... </li> 
     25<li> source:/matlab -- matlab input/output utilities </li> 
     26<li> source:/system -- a system specific parts necessary to run CMake </li> 
     27<li> source:/tests -- unit tests </li> 
     28<li> source:/utia_legacy -- ... </li> 
    1129</ul> 
    12   
    13  
    14 // \section cr_variables Default Naming Rules for Variables 
    1530 
    1631 

  • library/doc/tutorial/arx_ui.dox

    r471 r600  
    11/*! 
    2 \page arx_ui Running experiment \c estimator with ARX data fields 
     2\page arx_ui Running experiment \c estimator with ARX data fields \todo this page is out of date, as the user info concept has been changed 
    33 
    44The experiment \ref estimator.cpp can be run either on command line, or as a mex file in Matlab. 

  • library/doc/tutorial/ui.dox

    r471 r600  
    1616The User Infos are designed using customized version of the libconfig library (www.hyperrealm.com/libconfig). It is specialized for BDM so as to recognize basic mathematical objects, such as vectors and matrices, see details below. 
    1717  
    18 Technically it can be made compatible with matlab structures (TODO) 
     18Technically it can be made compatible with matlab structures.  
     19\todo it will be good to create a more detailed paragraph about the intraction with Matlab 
    1920 
    2021\section ui_example Example