Changeset 1470

Timestamp:

08/05/10 22:04:00 (21 months ago)

Author:

Freddie Akeroyd

Message:

Update docs. Refs #220

Location:

trunk

Files:

• applications/NXbrowse/NXbrowse.c (modified) (4 diffs)
• bindings/cpp/NeXusFile.cpp (modified) (2 diffs)
• src/napi.c (modified) (2 diffs)

trunk/applications/NXbrowse/NXbrowse.c

@@ -101 +101 @@
     { "close", "Move out of a group" },
     { "dir", "" },
+    { "ls", "" },
     { "read", "" },
     { "open", "" },
@@ -106 +107 @@
     { "info", "" },
     { "exit", "" },
+    { "quit", "" },
     { "dump", "" },
     { "bytesaschar", "" },
@@ -373 +375 @@
       if (StrEq(command, "HELP") || StrEq(command, "INFO")) {
          printf ("NXbrowse commands : DIR\n");
+         printf ("                    LS\n");
          printf ("                    OPEN <groupName>\n");
+         printf ("                    CD <groupName>\n");
          printf ("                    READ <dataName>\n");
          printf ("                    READ <dataName>[<dimension indices...>]\n");
@@ -381 +385 @@
          printf ("                    HELP\n");
          printf ("                    EXIT\n");
+         printf ("\n");
+         printf ("If readline support is enabled, pressing <TAB> after a command \n");
+         printf ("or partial nexus object name will list/complete possible names\n");
+         printf ("\n");
+         printf ("    cd ent<TAB KEY PRESSED>     # all items starting with ent are listed\n");
+         printf ("\n");
       }
       /* Command is to print byte as char information */

trunk/bindings/cpp/NeXusFile.cpp

@@ -20 +20 @@
  * - Exceptions
  * - suport for std::vector<type> and std::string
+ * - can directly obtain a container of entry/attribute details rather than needing to iterate via getNext calls. 
+ *
  *
  * \section sec_core Core C++ API
@@ -28 +30 @@
  * #include "NeXusFile.hpp"
  * \endcode
+ * For details of the C API see http://download.nexusformat.org/doxygen/html-c/
  */
 

trunk/src/napi.c

@@ -39 +39 @@
  * \mainpage NeXus API documentation
  * \section sec_purpose Purpose of API
- * The NeXus Application Program Interface is a suite of subroutines, written in C but with wrappers in Fortran 77 and 90. 
+ * The NeXus Application Program Interface is a suite of subroutines, written in C but with wrappers in C++, JAVA, PYTHON, Fortran 77 and 90. 
  *  The subroutines call HDF routines to read and write the NeXus files with the correct structure. 
  * An API serves a number of useful purposes: 
@@ -64 +64 @@
  * #include "napi.h"
  * \endcode
+ * For the C++ API see http://download.nexusformat.org/doxygen/html-cpp
  */