Changeset 70:7882bccb87a0 in xplra for doc/overview.dox

Timestamp:

04/13/13 12:54:56 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

(<MercurialRepository 3 'hg:/home/ivaradi/xplane/hg/xplra' '/'>, 'public')

Message:

Added the description of the C API

File:

• doc/overview.dox (modified) (4 diffs)

doc/overview.dox

@@ -25 +25 @@
  * computer that runs X-Plane, but extending it with TCP/IP-based or
  * network access would not be difficult. While client libraries are
- * provided for \ref cpplib "C, C++" and \ref pythonlib "Python",
+ * provided for \ref cppapi "C, C++" and \ref pythonapi "Python",
  * the communication protocol between clients and the plugin is open
  * and is \ref proto "described" in  this documentation. So you can
@@ -699 +699 @@
  * byte | 0x00 (\ref RESULT_OK)
  */
-/*! \page cpplib C/C++ Client Library
- *
- * The C++ client library's central class is \ref
+/*! \page cppapi C/C++ Client API
+ *
+ * The C++ client API's central class is \ref
  * hu::varadiistvan::xplra::XPlane. To communicate with the XPLRA
  * plugin in X-Plane, create an instance of it. This, however, does
@@ -710 +710 @@
  *
  * \c IOException is part of the exception hierarchy of the client
- * library. The hierarchy begins with \ref
+ * API. The hierarchy begins with \ref
  * hu::varadiistvan::xplra::Exception. The \c what function is
  * implemented for all exception classes, so you can always get a
@@ -752 +752 @@
  * have more than one corresponding functions with different
  * parameters for convenience.
+ *
+ * The \ref src/client/c/hu/varadiistvan/xplra/xplra.h "C API" is
+ * a wrapper over the C++ one, so its logic is essentially the
+ * same. To connect to X-Plane, call \ref xplra_connect. It returns a
+ * non-negative handle, which can be used to refer to the connection
+ * (i.e. the underlying \c XPlane object) in the other functions.
+ *
+ * In case of error, it, and most other functions of the C returns
+ * -1. To check what the last error was, call \ref
+ * xplra_get_last_error or \ref xplra_get_last_error_string.
+ *
+ * You can create multi-dataref buffers with C API as well with
+ * \ref xplra_multi_create_getter and \ref
+ * xplra_multi_create_setter. These return a buffer ID on success, and
+ * you should use that buffer ID later on to manipulate the buffer.
  */
-/*! \page pythonlib Python Client Library
+/*! \page pythonapi Python Client API
  *
  */