Add Connection function more filled in

1 files changed, 50 insertions, 5 deletions

diff --git a/noncore/net/networksetup/module.h b/noncore/net/networksetup/module.h
index c1e9488..0c81928 100644
--- a/noncore/net/networksetup/module.h
+++ b/noncore/net/networksetup/module.h
@@ -16,15 +16,60 @@ signals:
         
 public:
   Module(){};
-  
+ 
+  /**
+   * 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* i) = 0;
+
+  /**
+   * Check to see if the interface i is owned by this module.
+   * @param Interface* interface to check against
+   * @return bool true if i is owned by this module, false otherwise.
+   */
   virtual bool isOwner(Interface *){ return false; };
-  virtual QWidget *configure(QTabWidget **tabWidget){ return NULL; } ;
-  virtual QWidget *information(QTabWidget **tabWidget){ return NULL; };
+  
+  /**
+   * Create, set tabWiget and return the WLANConfigure Module
+   * @param tabWidget a pointer to the tab widget that this configure has.
+   * @return QWidget* pointer to the tab widget in this modules configure.
+   */
+  virtual QWidget *configure(QTabWidget **){ return NULL; } ;
+  
+  /**
+   * Create, set tabWiget and return the Information Module
+   * @param tabWidget a pointer to the tab widget that this information has.
+   * @return QWidget* pointer to the tab widget in this modules info.
+   */
+  virtual QWidget *information(QTabWidget **){ return NULL; };
+  
+  /**
+   * Get all active (up or down) interfaces
+   * @return QList<Interface> A list of interfaces that exsist that havn't
+   * been called by isOwner()
+   */  
   virtual QList<Interface> getInterfaces() = 0;
-  virtual QMap<QString, QString> possibleNewInterfaces() = 0;
+  
+  /**
+   * Adds possible new interfaces to the list (Example: usb(ppp), ir(ppp),
+   *  modem ppp)
+   */
+  virtual void possibleNewInterfaces(QMap<QString, QString> &list) = 0;
+  
+  /**
+   * Attempts to create a new interface from name
+   * @return Interface* NULL if it was unable to be created.
+   * @param name the type of interface to create
+   */  
   virtual Interface *addNewInterface(QString name) = 0;
+  
+  /**
+   * Attempts to remove the interface, doesn't delete i
+   * @return bool true if successfull, false otherwise.
+   */
   virtual bool remove(Interface* i) = 0;
-  virtual QString getPixmapName(Interface* i) = 0;
 
 };