Changeset 1563 for trunk/bindings


Ignore:
Timestamp:
08/10/10 20:46:46 (20 months ago)
Author:
Reuterma
Message:

Adding preamble and switching C and C++ documentation over to use it. This refs #257.

Location:
trunk/bindings/cpp
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/bindings/cpp/NeXusFile.cpp

    r1534 r1563  
    1717 * \file NeXusFile.cpp 
    1818 * The implementation of the NeXus C++ API 
    19  */ 
    20  
    21 /** 
    22  * \mainpage NeXus C++ API 
    23  * @author Peter Peterson 
    24  * @author Freddie Akeroyd 
    25  * \section sec_purpose Purpose of API 
    26  *  This provides a C++ like interface to the NeXus C API. It adds: 
    27  * - Exceptions 
    28  * - suport for std::vector<type> and std::string 
    29  * - can directly obtain a container of entry/attribute details rather than needing to iterate via getNext calls.  
    30  * 
    31  * 
    32  * \section sec_core Core C++ API 
    33  * The core API provides the basic routines for reading, writing and navigating NeXus files. See the \b Modules tab. 
    34  * 
    35  * C++ programs that call the above routines should include the following header file:  
    36  * \code 
    37  * #include "NeXusFile.hpp" 
    38  * \endcode 
    39  * 
    40  * \sa napi_test_cpp.cxx 
    41  * 
    42  * For details of the C API see http://download.nexusformat.org/doxygen/html-c/ 
    43  * 
    44  */ 
    45  
    46 /** 
    47  * \example napi_test_cpp.cxx 
    48  * Test program for the NeXus C++ Interface. 
    49  * This illustrates calling most of the functions for reading and writing a file 
    50  * 
    5119 */ 
    5220 

  • trunk/bindings/cpp/NeXusFile.hpp

    r1473 r1563  
    2525 
    2626/** 
    27  * \file 
    28  * Documentation for the NeXus C++ API. 
    29  * 2000-2008 the NeXus group. 
     27 * \file NeXusFile.hpp Definition of the NeXus C++ API. 
    3028 * \defgroup cpp_types C++ Types 
    31  * \ingroup cpp_main 
    3229 * \defgroup cpp_core C++ Core 
    3330 * \ingroup cpp_main 
Note: See TracChangeset for help on using the changeset viewer.