Ignore:
Timestamp:
09/05/10 14:28:15 (2 years ago)
Author:
Freddie Akeroyd
Message:

Improve comments and reference test programs. Refs #231.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bindings/cpp/NeXusFile.hpp

    r1468 r1473  
    257257     * Create a 1D data field, insert the data, and close the data. 
    258258     * 
     259     * \tparam NumT numeric data type of \a value 
    259260     * \param name The name of the field to create. 
    260261     * \param value The vector to put into the file. 
    … …  
    266267     * Create a 1D data field, insert the data, and close the data. 
    267268     * 
     269     * \tparam NumT numeric data type of \a value 
    268270     * \param name The name of the field to create. 
    269271     * \param value The value to put into the file. 
    … …  
    278280     * \param value The data to put into the file. 
    279281     * \param dims The dimensions of the data. 
     282     * \tparam NumT numeric data type of \a value 
    280283     */ 
    281284    template <typename NumT> 
    … …  
    305308     * \param comp The compression algorithm to use. 
    306309     * \param bufsize The size of the compression buffer to use. 
     310     * \tparam NumT numeric data type of \a value 
    307311     */ 
    308312    template <typename NumT> 
    … …  
    329333    /** 
    330334     * \param data The data to put in the file. 
     335     * \tparam NumT numeric data type of \a data 
    331336     */ 
    332337    template <typename NumT> 
    … …  
    346351     * \param name Name of the attribute to add. 
    347352     * \param value The attribute value. 
     353     * \tparam NumT numeric data type of \a value 
    348354     */ 
    349355    template <typename NumT> 
    … …  
    382388     * \param start The starting index to insert the data. 
    383389     * \param size The size of the array to put in the file. 
     390     * \tparam NumT numeric data type of \a data 
    384391     */ 
    385392    template <typename NumT> 
    … …  
    393400     * \param start The starting index to insert the data. 
    394401     * \param size The size of the array to put in the file. 
     402     * \tparam NumT numeric data type of \a data 
    395403     */ 
    396404    template <typename NumT> 
    … …  
    434442     * does call "new vector<NumT>" the caller is responsible for 
    435443     * calling "delete". 
     444     * \tparam NumT numeric data type of result 
    436445     * 
    437446     * \return The data as a vector. 
    … …  
    446455     * 
    447456     * \param data Where to put the data. 
     457     * \tparam NumT numeric data type of \a data 
    448458     */ 
    449459    template <typename NumT> 
    … …  
    496506     * 
    497507     * \param info Designation of which attribute to read. 
     508     * \tparam NumT numeric data type of result 
    498509     * 
    499510     * \return The attribute value. 
    … …  
    507518     * 
    508519     * \param[in] name Name of attribute to read 
    509      * 
    510520     * \param[out] value The read attribute value. 
     521     * \tparam NumT numeric data type of \a value 
    511522     */ 
    512523    template <typename NumT> 
    … …  
    594605  /** 
    595606   * This function returns the NXnumtype given a concrete number. 
     607   * \tparam NumT numeric data type of \a number to check 
    596608   */ 
    597609   template <typename NumT> 
Note: See TracChangeset for help on using the changeset viewer.