Changeset 1459 for trunk/include/napi.h

Timestamp:

06/05/10 18:32:30 (2 years ago)

Author:

Freddie Akeroyd

Message:

Re-order doxygen function grouping refs #220

File:

• trunk/include/napi.h (modified) (28 diffs)

trunk/include/napi.h

@@ -33 +33 @@
  * \defgroup c_init General Initialisation and shutdown
  * \ingroup c_main
- * \defgroup c_readwrite Reading and Writing
+ * \defgroup c_group Reading and Writing Groups
+ * \ingroup c_main
+ * \defgroup c_readwrite Reading and Writing Data
+ * \ingroup c_main
+ * \defgroup c_navigate General File navigation
  * \ingroup c_main
  * \defgroup c_metadata Meta data routines
  * \ingroup c_main
- * \defgroup c_linking Linking and Group hierarchy
+ * \defgroup c_linking Linking 
  * \ingroup c_main
  * \defgroup c_memory Memory allocation
@@ -43 +47 @@
  * \defgroup c_external External linking
  * \ingroup c_main
- * \defgroup cpp_main C++ API
  */
   
@@ -298 +301 @@
    * \param NXclass the class name of the group. Should start with the prefix NX
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_group
    */
 extern  NXstatus  NXmakegroup (NXhandle handle, CONSTCHAR *name, CONSTCHAR* NXclass);
@@ -308 +311 @@
    * \param NXclass the class name of the group. Should start with the prefix NX
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_group
    */
 extern  NXstatus  NXopengroup (NXhandle handle, CONSTCHAR *name, CONSTCHAR* NXclass);
@@ -319 +322 @@
    * Example: /entry1/sample/name 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_navigation 
    */
 extern  NXstatus  NXopenpath (NXhandle handle, CONSTCHAR *path);
@@ -330 +333 @@
    * Example: /entry1/sample/name 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_navigation 
    */
 extern  NXstatus  NXopengrouppath (NXhandle handle, CONSTCHAR *path);
+
   /**
    * Retrieve the current path in the NeXus file
    * \param handle a NeXus file handle
    * \param path A buffer to copy the path too
-   * \parm  pathlen The maximum number of characters to copy into path
+   * \param  pathlen The maximum number of characters to copy into path
    * \return NX_OK or NX_ERROR
+   * \ingroup c_navigation
    */
 extern NXstatus NXgetpath(NXhandle handle, char *path, int pathlen);
@@ -346 +351 @@
    * hierarchy.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_group 
    */
 extern  NXstatus  NXclosegroup(NXhandle handle);
@@ -359 +364 @@
    * can be NX_UNLIMITED. Data can be appended to such a dimension using NXputslab. 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_readwrite
    */
 extern  NXstatus  NXmakedata (NXhandle handle, CONSTCHAR* label, int datatype, int rank, int dim[]);
@@ -381 +386 @@
    * should be the same as the data dimension. If you write it in slabs, this is your preferred slab size. 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_readwrite
    */
 extern  NXstatus  NXcompmakedata (NXhandle handle, CONSTCHAR* label, int datatype, int rank, int dim[], int comp_typ, int bufsize[]);
@@ -394 +399 @@
    * \li NX_COMP_RLE run length encoding (only HDF-4)
    * \li NX_COMP_HUF Huffmann encoding (only HDF-4)
-   * \ingroup c_init
+   * \ingroup c_readwrite
    */
 extern  NXstatus  NXcompress (NXhandle handle, int compr_type);
@@ -404 +409 @@
    * \param label The name of the dataset
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_readwrite 
    */
 extern  NXstatus  NXopendata (NXhandle handle, CONSTCHAR* label);
@@ -412 +417 @@
    * \param handle A NeXus file handle as initialized by NXopen. 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_readwrite 
    */
 extern  NXstatus  NXclosedata(NXhandle handle);
@@ -423 +428 @@
    * \param data Pointer to data to write.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_init
+   * \ingroup c_readwrite
    */
 extern  NXstatus  NXputdata(NXhandle handle, void* data);
@@ -460 +465 @@
    * for linking. 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_linking
    */
 extern  NXstatus  NXgetdataID(NXhandle handle, NXlink* pLink);
@@ -471 +476 @@
    * by either a call to NXgetdataID or NXgetgroupID.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_linking
    */
 extern  NXstatus  NXmakelink(NXhandle handle, NXlink* pLink);
@@ -492 +497 @@
    * \param handle A NeXus file handle as initialized by NXopen.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_linking
+   * \ingroup c_navigation
    */
 extern  NXstatus  NXopensourcegroup(NXhandle handle);
@@ -522 +527 @@
   /**
    * Get the next entry in the currently open group. This is for retrieving infromation about the 
-   * content of a NeXus group. In order to search a group NXgetnextentry is called in a loop until 
-   * NXgetnextentry returns NX_EOD which indicates that there are no further items in the group.
+   * content of a NeXus group. In order to search a group #NXgetnextentry is called in a loop until 
+   * #NXgetnextentry returns NX_EOD which indicates that there are no further items in the group.
+   * Reset search using #NXinitgroupdir
    * \param handle A NeXus file handle as initialized by NXopen.
    * \param name The name of the object
@@ -529 +535 @@
    * \param datatype The NeXus data type if the item is a SDS. 
    * \return NX_OK on success, NX_ERROR in the case of an error, NX_EOD when there are no more items.   
-   * \ingroup c_readwrite
+   * \ingroup c_navigation
    */
 extern  NXstatus  NXgetnextentry(NXhandle handle, NXname name, NXname nxclass, int* datatype);
@@ -547 +553 @@
   /**
    * Iterate over global, group or dataset attributes depending on the currently open group or 
-   * dataset. In order to search attributes multiple calls to NXgetnextattr are performed in a loop 
-   * until NXgentnextattr returns NX_EOD which indicates that there are no further attributes.
+   * dataset. In order to search attributes multiple calls to #NXgetnextattr are performed in a loop 
+   * until #NXgetnextattr returns NX_EOD which indicates that there are no further attributes.
+   * reset search using #NXinitattrdir
    * \param handle A NeXus file handle as initialized by NXopen.
    * \param pName The name of the attribute
@@ -559 +566 @@
 
   /**
-   * Read an attribute.
+   * Read an attribute. 
    * \param handle A NeXus file handle as initialized by NXopen.
    * \param name The name of the atrribute to read.
@@ -575 +582 @@
    * \param no_items A pointer to an integer which be set to the number of attributes available.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_metadata
    */
 extern  NXstatus  NXgetattrinfo(NXhandle handle, int* no_items);
@@ -586 +593 @@
    * for linking. 
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_linking
    */
 extern  NXstatus  NXgetgroupID(NXhandle handle, NXlink* pLink);
@@ -599 +606 @@
    * \param nxclass The NeXus class name of the group.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_metadata
    */
 extern  NXstatus  NXgetgroupinfo(NXhandle handle, int* no_items, NXname name, NXname nxclass);
@@ -609 +616 @@
    * \param pSecondID The second link data structure.
    * \return NX_OK when both link data structures describe the same item, NX_ERROR else.   
-   * \ingroup c_readwrite
+   * \ingroup c_linking
    */
 extern  NXstatus  NXsameID(NXhandle handle, NXlink* pFirstID, NXlink* pSecondID);
-  /**
-   * Resets a pending group search to the start again. To be called in a Nxgetnextentry loop when 
+
+  /**
+   * Resets a pending group search to the start again. To be called in a #NXgetnextentry loop when 
    * a group search has to be restarted.
    * \param handle A NeXus file handle as initialized by NXopen.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_navigation 
    */
 extern  NXstatus  NXinitgroupdir(NXhandle handle);
 
   /**
-   * Resets a pending attribute search to the start again. To be called in a Nxgetnextattr loop when 
+   * Resets a pending attribute search to the start again. To be called in a #NXgetnextattr loop when 
    * an attribute search has to be restarted.
    * \param handle A NeXus file handle as initialized by NXopen.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_navigation
    */
 extern  NXstatus  NXinitattrdir(NXhandle handle);
@@ -648 +656 @@
    * \param  filenameBufferLength The length of the filename buffer.
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_metadata
    */
 extern  NXstatus  NXinquirefile(NXhandle handle, char *filename, int filenameBufferLength);
@@ -661 +669 @@
    * \param urlLen The length of the Url buffer. At maximum urlLen bytes will be copied to url.
    * \return NX_OK when the group is pointing to an external file, NX_ERROR else.
-   * \ingroup c_readwrite
+   * \ingroup c_external
    */
 extern  NXstatus  NXisexternalgroup(NXhandle handle, CONSTCHAR *name, CONSTCHAR *nxclass, char *url, int urlLen); 
@@ -675 +683 @@
    * path to the group in the external file which appears in the first file.  
    * \return NX_OK on success, NX_ERROR in the case of an error.   
-   * \ingroup c_readwrite
+   * \ingroup c_external
    */
 extern  NXstatus  NXlinkexternal(NXhandle handle, CONSTCHAR *name, CONSTCHAR *nxclass, CONSTCHAR *url);
@@ -764 +772 @@
 extern  NXstatus  NXIprintlink(NXhandle fid, NXlink* link);
 
-/*
-  another special function for setting the default cache size for HDF-5
-*/
+/**
+ * A function for setting the default cache size for HDF-5
+ * \ingroup c_init
+ */
 extern  NXstatus  NXsetcache(long newVal);