Changeset 1474

Timestamp:

09/05/10 16:30:02 (21 months ago)

Author:

Freddie Akeroyd

Message:

More doc tweaks. Also now automatically builds javadoc for web. Refs #231

Location:

trunk

Files:

• bindings/cpp/NeXusFile.cpp (modified) (1 diff)
• bindings/java/Makefile.am (modified) (5 diffs)
• bindings/java/org/nexusformat/NexusFile.java (modified) (2 diffs)
• bindings/python/nxs/napi.py (modified) (3 diffs)
• doc/doxygen/Doxyfile_c (modified) (2 diffs)
• doc/doxygen/Doxyfile_cpp (modified) (1 diff)
• src/napi.c (modified) (1 diff)

trunk/bindings/cpp/NeXusFile.cpp

@@ -33 +33 @@
  * \endcode
  *
- * \example napi_test_cpp.cxx
- * Test program for NeXus C++ Interface
+ * \sa napi_test_cpp.cxx
  *
  * For details of the C API see http://download.nexusformat.org/doxygen/html-c/
+ *
+ */
+
+/**
+ * \example napi_test_cpp.cxx
+ * Test program for the NeXus C++ Interface.
+ * This illustrates calling most of the functions for reading and writing a file
+ *
  */
 

trunk/bindings/java/Makefile.am

@@ -77 +77 @@
                ncsa/hdf/hdflib/ArrayDescriptor.class
 
-clean-local:
-                rm -rf apidoc
 
 noinst_JAVA     = ncsa/hdf/hdflib/HDFArray.java \
@@ -93 +91 @@
                 test/TestJapi.java
 
-EXTRA_DIST      = $(noinst_JAVA) README.JNEXUS COPYING.NCSA 
+EXTRA_DIST      = $(noinst_JAVA) README.JNEXUS COPYING.NCSA
 
 # specific targets
@@ -102 +100 @@
         $(JAVAH) -jni -d native -classpath . org.nexusformat.NexusFile
 
-jnexus.jar: $(jnexus_jar_CLASS)
+jnexus.jar: $(jnexus_jar_CLASS) apidoc
         $(JAR) cvf jnexus.jar $(jnexus_jar_CLASS) \
                ncsa/hdf/hdflib/ArrayDescriptor.class
 
-#all: $(jnexus_jar_ARCHIVE) $(lib_LTLIBRARIES) javadoc
-
-javadoc:        $(noinst_JAVA)
-        test -d apidoc || mkdir apidoc
-        $(JAVADOC) -d apidoc -windowtitle jnexus -doctitle jnexus -classpath . \
-                      -sourcepath $(srcdir) org.nexusformat ncsa.hdf.hdflib
 
 SUFFIXES = .java .class
@@ -118 +110 @@
         $(JAVAC) -d $(JAVAROOT) $(AM_JAVACFLAGS) $(JAVACFLAGS) $<
 
+apidoc : $(noinst_JAVA)
+        test -d apidoc || mkdir apidoc
+        $(JAVADOC) -d apidoc -windowtitle jnexus -doctitle jnexus -classpath . \
+                      -sourcepath $(srcdir) org.nexusformat ncsa.hdf.hdflib
+
+dist-hook :
+        if test -d $(srcdir)/apidoc; then \
+            cp -r $(srcdir)/apidoc $(distdir); \
+        fi
+
+install-data-local :
+        $(mkinstalldirs) $(DESTDIR)$(nxjavadocdir)
+        if test -d $(srcdir)/apidoc; then \
+          cp -r $(srcdir)/apidoc $(DESTDIR)$(nxjavadocdir); \
+          find $(DESTDIR)$(nxjavadocdir)/apidoc -type f -exec chmod 0644 {} \; ;\
+          find $(DESTDIR)$(nxjavadocdir)/apidoc -type d -exec chmod 0755 {} \; ;\
+        fi
+
+clean-local :
+        rm -rf apidoc
+
+uninstall-local :
+        rm -fr $(DESTDIR)$(nxjavadocdir)/apidoc
+
+#
 # Windows import library for DLL
 
@@ -136 +153 @@
 endif
 
+
 ## include $(top_srcdir)/build_rules.am

trunk/bindings/java/org/nexusformat/NexusFile.java

@@ -11 +11 @@
   * different calling standards between C and Java. 
   *
-  * @example TestJapi.java
-  * Test program for Java API
   *
   * @author Mark Koennecke, October 2000
@@ -21 +19 @@
   *
   * added nxinitattrdir: Mark Koennecke, October 2009 
+  *
+  * @see TestJapi.java
+  *
+  */
+
+  /**
+  * @example TestJapi.java
+  * Test program for Java API.
+  * Illustrates using the #org.nexusformat package
   */
 package org.nexusformat;

trunk/bindings/python/nxs/napi.py

@@ -17 +17 @@
    os.environ['NEXUSLIB']                  - All
    directory containing nxs.py             - All
-   os.environ['NEXUSDIR']\bin              - Windows
+   os.environ['NEXUSDIR']\\bin              - Windows
    os.environ['LD_LIBRARY_PATH']           - Unix
    os.environ['DYLD_LIBRARY_PATH']         - Darwin
@@ -50 +50 @@
 @endcode
 
-  See @example nxstest.py for a more complete example.
+  See @see nxstest.py for a more complete example.
 
 Interface
@@ -125 +125 @@
 
 """
+
+## @example nxstest.py
+#  Test program for NeXus python interface
 
 __all__ = ['UNLIMITED', 'MAXRANK', 'MAXNAMELEN','MAXPATHLEN','H4SKIP',

trunk/doc/doxygen/Doxyfile_c

@@ -628 +628 @@
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = $(TOPSRC)/test
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
@@ -635 +635 @@
 # blank all files are included.
 
-EXAMPLE_PATTERNS       =
+EXAMPLE_PATTERNS       = *.c *.h
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be

trunk/doc/doxygen/Doxyfile_cpp

@@ -642 +642 @@
 # blank all files are included.
 
-EXAMPLE_PATTERNS       = *.cpp *.cxx
+EXAMPLE_PATTERNS       = *.cpp *.cxx *.hpp
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be

trunk/src/napi.c

@@ -67 +67 @@
  */
 
+/**
+ * \example napi_test.c
+ * This is the test program for the NeXus C API.
+ * It illustrates calling most functions to read and write a file.
+ */