updated documentation, formatting

[deb_libcec.git] / include / cec.h

diff --git a/include/cec.h b/include/cec.h
index e7ee890dcc3e360e4f7c6ff0069d43a011b55e62..40df4ce0267d7764ba891901e8062e2e94c6e36e 100644 (file)
--- a/include/cec.h
+++ b/include/cec.h
@@ -40,6 +40,17 @@
 
 namespace CEC
 {
+  /*!
+   * To create a new libCEC instance, call CECInitialise() and pass the
+   * configuration as argument. Then call Open() to open a connection to the
+   * adapter. Close() closes the connection and CECDestroy() cleans up the
+   * libCEC instance.
+   *
+   * libCEC can send commands to other devices on the CEC bus via the methods
+   * on this interface, and all commands that libCEC received are sent back
+   * to the application via callback methods. The callback methods can be
+   * found in cectypes.h, ICECCallbacks.
+   */
   class ICECAdapter
   {
   public: