API doc update

1 files changed, 6 insertions, 2 deletions

diff --git a/noncore/net/opietooth/lib/device.h b/noncore/net/opietooth/lib/device.h
index b2d277e..d6cf049 100644
--- a/noncore/net/opietooth/lib/device.h
+++ b/noncore/net/opietooth/lib/device.h
@@ -1,63 +1,67 @@
 
 #ifndef OpieToothDevice_H
 #define OpieToothDevice_H
 
 #include <qobject.h>
 #include <qstring.h>
 #include <qvaluelist.h>
 
 namespace OpieTooth {
-
+    /**
+     *  Device takes care of attaching serial 
+     *  devices to the blueZ stack.
+     *  After attaching it hciconfig ups it
+     */
     class Device : public QObject {
     Q_OBJECT
 
     public:
 
     /**
      * Brings up an device.
      * Usage example: new Device(/dev/ttySB0, csr)
      *
      * @param &device QString the device name
      * @param &mode QString the mode
      */
     Device(const QString &device, const QString& mode);
 
         /**
          * unloads the device
          */
         ~Device();
 
         /**
          * attach the device
          */
         void attach();
 
         /**
          * detach the device
          */
         void detach();
 
         /**
          * Is the device loaded?
          * @return bool, if the device is loaded
-
+         */
         bool isLoaded()const;
 
         /**
          * Returns the device name
          * @return QString, the device name
          */
         QString devName()const ; // hci0
 
     signals:
 
         /**
          * Signals devicename and up status
          * @return &device QString, Devicename
          * @return up bool, if the device is up or not.
          */
         device(const QString& device, bool up );
     };
 };
 
 #endif