[Nexus-developers] napi tests and documentation

[Akeroyd, FA (Freddie)]

1) One executable that takes an -hdf4 or -hdf5 argument sounds the best;
then "make test" can pass the appropriate arguments as it will know what
libraries are available on the system at that time

2) On the subject of documentation, we should have a discussion about
in-code documentation that could be used to automatically build help pages
from CVS; something like doxygen (http://www.doxygen.org/) Anybody have
views or experience on using such tools? The core NeXus API being in C opens
up a long list of possibilities, but if we wanted to use the same tool to
document the various other language bindings then that would cut the list
down a bit. Maybe we just use the most appropriate tool for a given language
with the understanding that the various bindings may have slightly different
"look and feel" to their web help pages. For example, I have recently been
using f90doc (http://theory.lcs.mit.edu/~edemaine/f90doc/) for FORTRAN90
documentation and found it be both simple to use and very powerful.

Freddie  

-----Original Message-----
From: nexus-developers-bounces at anl.gov
[mailto:nexus-developers-bounces at anl.gov] On Behalf Of Peterson, Peter F.
Sent: 07 May 2004 20:56
To: nexus-developers at anl.gov
Subject: [Nexus-developers] napi tests and documentation

I am proposing two changes to files in cvs.

1) Combine napi4_test.c and napi5_test.c into a single file. This can be
used to either create two executables or one executable that takes a commad
line argument "-hdf4" or "-hdf5".

2) Document in napi.h what the c types are for NX_INT[8,16,32] and
NX_UINT[8,16,32]. I just spent way to long searching through test and
example programs looking for something that would be much easier in the
header file itself.

If no one objects within the next couple of (buisiness) days I'll implement
these changes and check them in.

P^2
--
Spallation Neutron Source
Oak Ridge National Laboratory
Tel: 630-252-8397  Fax: 630-252-7777





_______________________________________________
NeXus-developers mailing list
NeXus-developers at anl.gov
http://www.neutron.anl.gov/mailman/listinfo/nexus-developers