bindings: Remove 'get_' prefix from all accessors.

[libsigrok.git] / bindings / java / org / sigrok / core / classes / classes.i

diff --git a/bindings/java/org/sigrok/core/classes/classes.i b/bindings/java/org/sigrok/core/classes/classes.i
index 52eace85a7acfc7ed778b6fe07a8d3bf821dcd19..4fe326d158c77c4c8e90fe92b7f80117a994118b 100644 (file)
--- a/bindings/java/org/sigrok/core/classes/classes.i
+++ b/bindings/java/org/sigrok/core/classes/classes.i
@@ -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 */
@@ -199,6 +224,15 @@ MAP_COMMON(const sigrok::ConfigKey *, Glib::VariantBase, ConfigKey, Variant)
   }
 }
 
+/* Support InputFormat.create_input() with no options. */
+%extend sigrok::InputFormat {
+  std::shared_ptr<sigrok::Input> create_input()
+  {
+    std::map<std::string, Glib::VariantBase> options;
+    return $self->create_input(options);
+  }
+}
+
 /* Support OutputFormat.create_output(device) with no options. */
 %extend sigrok::OutputFormat {
   std::shared_ptr<sigrok::Output> create_output(
@@ -342,7 +376,5 @@ typedef jobject jsourcecallback;
   }
 }
 
-/* Currently broken due to some std::map typemap issues. */
-%ignore sigrok::Meta::get_config;
-
+%include "doc.i"
 %include "bindings/swig/classes.i"