BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

java: Add documentation generation.

This commit is contained in:
Martin Ling 2014-08-01 19:29:48 +01:00 committed by Uwe Hermann
parent 6a8c1d6879
commit 8a314e90ff
3 changed files with 2336 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile.am
View File

@ -522,6 +522,10 @@ java-clean:
rm -f $(JINT)/*.class
rm -f $(JJAR)
rm -f $(JLIB)
rm -rf $(JDIR)/doxy/
java-doc:
$(AM_v_at)cd $(JDIR) && doxygen Doxyfile
BUILD_EXTRA += java-build
INSTALL_EXTRA += java-install

2303
bindings/java/Doxyfile Normal file
View File

File diff suppressed because it is too large Load Diff

33
bindings/java/org/sigrok/core/classes/classes.i
View File

@ -7,11 +7,36 @@
}
%}
/* Import interfaces. */
/* Documentation & importing interfaces. */
%pragma(java) jniclassimports=%{
import org.sigrok.core.interfaces.LogCallback;
import org.sigrok.core.interfaces.DatafeedCallback;
import org.sigrok.core.interfaces.SourceCallback;
/**
* @mainpage API Reference
*
* Introduction
* ------------
*
* The sigrok-java API provides an object-oriented Java interface to the
* functionality in libsigrok. It is built on top of the sigrok++ C++ API.
*
* Getting started
* ---------------
*
* Usage of the sigrok-java API needs to begin with a call to Context.create().
* This will create the global libsigrok context and returns a Context object.
* Methods on this object provide access to the hardware drivers, input and
* output formats supported by the library, as well as means of creating other
* objects such as sessions and triggers.
*
* Error handling
* --------------
*
* When any libsigrok C API call returns an error, an Error exception is raised,
* which provides access to the error code and description.
*/
import org.sigrok.core.interfaces.LogCallback;
import org.sigrok.core.interfaces.DatafeedCallback;
import org.sigrok.core.interfaces.SourceCallback;
%}
/* Map Java FileDescriptor objects to int fds */