More API fixes

2 files changed, 19 insertions, 0 deletions

diff --git a/noncore/settings/networksettings/interfaces/interface.h b/noncore/settings/networksettings/interfaces/interface.h
index ec82851..83ab088 100644
--- a/noncore/settings/networksettings/interfaces/interface.h
+++ b/noncore/settings/networksettings/interfaces/interface.h
@@ -1,20 +1,27 @@
 #ifndef INTERFACE_H
 #define INTERFACE_H
 
 #include <qstring.h>
 #include <qobject.h>
 
 class Module;
 
+/**
+ * A Interface represents a physical device. You can
+ * inherit it and create also virtual devices. Like saved
+ * ppp dial ups or vpn. Interface is used for representing
+ * your interface to the User and its actions.
+ *
+ */
 class Interface : public QObject{
   Q_OBJECT
 
 signals:
   void updateInterface(Interface *i);
   void updateMessage(const QString &message);
 
 public:
   Interface(QObject * parent=0, const char * name= "unknown", bool status = false);
 
   QString getInterfaceName() const { QString n(this->name()); return n; };
   void setInterfaceName( const QString &n ) { this->setName(n); };
diff --git a/noncore/settings/networksettings/module.h b/noncore/settings/networksettings/module.h
index 3ef823c..9dc913e 100644
--- a/noncore/settings/networksettings/module.h
+++ b/noncore/settings/networksettings/module.h
@@ -77,26 +77,34 @@ public:
 
   /**
    * get the icon name for this device.
    * @param Interface* can be used in determining the icon.
    * @return QString the icon name (minus .png, .gif etc)
    */
   virtual QString getPixmapName(Interface *) = 0;
 
   /**
    * Check to see if the interface i is owned by this module.
    * See if you can handle it. And if you can claim ownership
    * by returning true.
+   * For physical devices you will be asked if you want to own the
+   * device. But you can also create new \sa Interface Implementations.
+   *
+   * If you want to own the Interface add it to your internal interface
+   * list
+   *
    * @param Interface* interface to check against
    * @return bool true if i is owned by this module, false otherwise.
+   *
+   * @see getInterfaces
    */
   virtual bool isOwner(Interface *){ return false; };
 
   /**
    * Create and return the Configure Module
    * @param Interface *i the interface to configure.
    * @return QWidget* pointer to this modules configure.
    *
    * @see InterfaceSetupImp
    */
   virtual QWidget *configure(Interface *){ return NULL; } ;
 
@@ -107,24 +115,28 @@ public:
    *
    * @param Interface *i the interface to get info on.
    * @return QWidget* pointer to this modules info.
    *
    * @see InterfaceInformationImp
    *
    */
   virtual QWidget *information(Interface *){ return NULL; };
 
   /**
    * Get all active (up or down) interfaces managed by this
    * module.
+   * At the end of initialisation you will be asked to return your interfaces
+   * Return all of your interfaces even  the ones you claimed by isOnwer.
+   * Here you can also return your 'virtual' Interface Objects
+   *
    * @return QList<Interface> A list of interfaces that exsist that havn't
    * been called by isOwner()
    */
   virtual QList<Interface> getInterfaces() = 0;
 
   /**
    * Adds possible new interfaces to the list (Example: usb(ppp), ir(ppp),
    *  modem ppp)
    * Both strings need to be translated. The first string is a Shortcut
    * like PPP and the second argument is a description.
    *
    * <code>