[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    playground/network/ksniffer
From:       Giovanni Venturi <gventuri73 () tiscali ! it>
Date:       2008-12-06 11:39:01
Message-ID: 1228563541.287821.22447.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 893252 by gianni:

some more doxygen stuff

 M  +132 -26   ksniffer.h  


--- trunk/playground/network/ksniffer/ksniffer.h #893251:893252
@@ -236,49 +236,112 @@
   void startSniffingFromFile();
 
 private:
+  /**
+   * The status bar action
+   */
   KToggleAction *m_statusbarAction;
 
   /**
-   * the action to start new network packet-capture
+   * The action to start new network packet-capture
    */
   KAction *m_actNew;
 
   /**
-   * the action to open a file
+   * The action to open a file
    */
   KAction *m_actOpen;
-  KAction *m_actSave;                   // the action to save a file with all \
                network captured packets
-  KAction *m_actSaveAs;                 // the action to "save as" a file with all \
                network captured packets
-  //KAction *m_actPrint;                  // the action to print captured packets
-  KAction *m_actPauseContinue;          // the action to pause / continue capturing \
                packets
-  KAction *m_actStop;                   // the action to stop network packet-capture
-  QString m_whatsthisPause;             // the string for the what's this help for \
                Pause Capture
-  KRecentFilesAction *m_actOpenRecent;  // the action to open recent URL
-  bool m_doingCapture;                  // true if it's sniffing
-  bool m_doingPause;                    // true if capture is in pause
-  bool m_captureEnabled;                 // true if you can capture from network \
interfaces  
+  /**
+   * The action to save a file with all captured packets
+   */
+  KAction *m_actSave;
+
+  /**
+   * The action to "save as" a file with all captured packets
+   */
+  KAction *m_actSaveAs;
+
+  /**
+   * the action to print captured packets
+   */
+  //KAction *m_actPrint;
+
+  /**
+   * The action to pause/continue capturing packets
+   */
+  KAction *m_actPauseContinue;
+
+  /**
+   * The action to stop packets capture
+   */
+  KAction *m_actStop;
+
+  /**
+   * The string for the what's this help for Pause/Continue Capture
+   */
+  QString m_whatsthisPause;
+
+  /**
+   * The action to open recent URL
+   */
+  KRecentFilesAction *m_actOpenRecent;
+
+  /**
+   * True if it's sniffing
+   */
+  bool m_doingCapture;
+
+  /**
+   * True if capture is in pause state
+   */
+  bool m_doingPause;
+
+  /**
+   * True if you can capture from network interfaces
+   */
+  bool m_captureEnabled;
+
+  /**
+   * Reference to the port number from /etc/services
+   */
   PortNumberNameList *m_portNumberNameList;
+
+  /**
+   * Reference to the Sniffer class that manage the packet capture
+   */
   Sniffer *m_sniffer;
+
+  /**
+   * Reference to the Capture Option dialog
+   */
   CaptureOptions *m_options;
+
+  /**
+   * Reference to the KSniffer Configuration
+   */
   KSnifferConfig *m_ksnifferConfig;
 
-  // is needed a PacketManager to store packets and manage them for the View
+  /**
+   * The PacketManager reference to store packets and manage them for the View
+   */
   PacketManager *m_packets;
 
-  // needed to know if sniffing is from file or not
+  /**
+   * True if it's sniffing from file.
+   * False if it's sniffing live.
+   */
   bool m_loadFromFile;
 
   /**
-   * needed by slotStop to understand if it's showing captured packets
+   * Needed by slotStop to understand if it's showing captured packets
    * after capture was stopped (true)
    * or if it's displaying packets from a selected file (false)
    */
   bool m_startedShowing;
 
   /**
-   * need to remove temporary file when I load a non local file
-   * and packets are available: to avoid it doesn't remove temporary file not needed
+   * Need to remove temporary file when I load a remote file and packets
+   * are available: to avoid it doesn't remove temporary file not needed
    */
   bool m_wroteTmpLocalFile;
 
@@ -287,22 +350,62 @@
    */
   enum {ACT_DO_NOTHING = 0, ACT_QUIT_APPL = 1, ACT_SAVING_PACKETS = 2};
 
-  // the action after Job
+  /**
+   * The action after Job: ACT_DO_NOTHING, ACT_QUIT_APPL, ACT_SAVING_PACKETS
+   */
   int m_action;
 
-  QString m_strFilename;       // the filename to save
-  KURL m_strSavedFilename;     // the filename saved
-  bool m_needToSave;           // true if data needs to be saved before quit
-  KTempFile *m_tmpFile;        // temporary file needed when loading a not local \
                file
-  KConfig *m_config;           // global KSniffer configuration
-  bool m_mustShowPacketsNow;   // true is started capturing with the 'after show \
packets' option enabled +  /**
+   * The filename to save
+   */
+  QString m_strFilename;
+
+  /**
+   * The saved filename
+   */
+  KURL m_strSavedFilename;
+
+  /**
+   * true if data need to be saved before quit
+   */
+  bool m_needToSave;
+
+  /**
+   * temporary file needed when loading a remote file
+   */
+  KTempFile *m_tmpFile;
+
+  /**
+   * global KSniffer configuration
+   */
+  KConfig *m_config;
+
+  /**
+   * true if the capture is started with the 'after show packets' option enabled
+   */
+  bool m_mustShowPacketsNow;
+
+  /**
+   * true if the tray bar has to be shown
+   */
   bool m_showTrayBar;
+
+  /**
+   * Timer reference to check if it's sniffing
+   */
   QTimer *m_timer;
 
-  long m_filesize;             // size of the sniffing file
-  KProcess *m_sniffProcess;    // the suid process to sniff packets on file
+  /**
+   * size of the sniffing file
+   */
+  long m_filesize;
 
   /**
+   * The suid process to sniff packets on file
+   */
+  KProcess *m_sniffProcess;
+
+  /**
    * The string error reported by a network failure in ksniff application
    */
   QString m_sniffProcessErrorText;
@@ -312,6 +415,9 @@
    */
   QString m_currentInterfaceText;
 
+  /**
+   * The passive popup window for the messages
+   */
   KSnifferPassivePopup m_messagePopup;
 };
 


[prev in list] [next in list] [prev in thread] [next in thread]