Changeset 1536 for trunk/bindings


Ignore:
Timestamp:
06/10/10 15:15:01 (20 months ago)
Author:
Reuterma
Message:

Updating stream class documentation. This refs #250.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bindings/cpp/NeXusStream.hpp

    r1219 r1536  
    5252namespace Stream 
    5353{ 
    54     // interface implemented by all serialisable NeXus components 
     54  /** 
     55   * interface implemented by all serialisable NeXus components 
     56   */ 
    5557    class NXDLL_EXPORT ISerialisable 
    5658    { 
    … …  
    6365    enum StreamModifier { Close=0 }; 
    6466 
     67  /** 
     68   * Base class for serialisable named and typed parameter 
     69   */ 
    6570    class NXDLL_EXPORT HolderBase : public ISerialisable 
    6671    { 
    … …  
    7883    }; 
    7984 
     85  /** 
     86   * Serialisable NeXus attribute 
     87   */ 
    8088    template<typename NumT> 
    8189    class NXDLL_EXPORT AttrHolder : public HolderBase 
    … …  
    99107    }; 
    100108 
    101     /// \ingroup cpp_stream 
     109  /** 
     110   * Serialisable attribute 
     111   * \ingroup cpp_stream 
     112   */ 
    102113    class NXDLL_EXPORT Attr : public ISerialisable 
    103114    { 
    … …  
    125136    }; 
    126137 
    127      
     138  /** 
     139   * Serialisable NeXus class with associated attributes 
     140   */ 
    128141    class NXDLL_EXPORT ObjectWithAttr : public ISerialisable 
    129142    { 
    … …  
    169182    }; 
    170183     
    171     /// \ingroup cpp_stream 
     184  /** 
     185   * Serialisable NeXus group object 
     186   * \ingroup cpp_stream 
     187   */ 
    172188    class NXDLL_EXPORT Group : public ObjectWithAttr 
    173189    { 
    … …  
    198214    }; 
    199215 
     216  /** 
     217   * Serialisable NeXus data 
     218   */ 
    200219    template<typename NumT> 
    201220    class NXDLL_EXPORT DataHolder : public HolderBase 
    … …  
    220239    }; 
    221240 
    222     /// \ingroup cpp_stream 
     241  /** 
     242   * Serialisable data object that contains attributes 
     243   * \ingroup cpp_stream 
     244   */ 
    223245    class NXDLL_EXPORT Data : public ObjectWithAttr 
    224246    { 
Note: See TracChangeset for help on using the changeset viewer.