2006-08-31 Esteban Sanchez <estebans@artica.es>

* pandora.cc, pandora_strutils.h, windows_service.h, wmi/pandora_wmi.cc, ssh/pandora_ssh_test.cc: Documentation comments updated.

        * ssh/pandora_ssh_client.[h,cc]: Documentation comments updated. Comment deleted.

        * windows_service.cc: Comment deleted.


git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@151 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f

pandora_agents/win32/ChangeLog

@@ -1,3 +1,14 @@
+2006-08-31  Esteban Sanchez  <estebans@artica.es>
+
+	* pandora.cc, pandora_strutils.h, windows_service.h,
+	wmi/pandora_wmi.cc, ssh/pandora_ssh_test.cc: Documentation comments
+	updated.
+	
+	* ssh/pandora_ssh_client.[h,cc]: Documentation comments updated.
+	Comment deleted.
+
+	* windows_service.cc: Comment deleted.
+	
 2006-08-15  Esteban Sanchez  <estebans@artica.es>
 
 	* autogen.sh, configure.in, Makefile.am, Doxyfile.in: Added to

pandora_agents/win32/pandora.cc

@@ -127,7 +127,7 @@ pandoraWriteLog (string filename, string line) {
  * The log file is used to write the output of errors and problems of the
  * agent.
  *
- * @param format String output format.
+ * @param format String output format (like printf).
  * @param ... Variable argument list
  */
 void

pandora_agents/win32/pandora_strutils.h

@@ -37,7 +37,7 @@ namespace Pandora_Strutils {
         class String_Exception : Pandora::Pandora_Exception {};
 	
 	/**
-	 * Exception throwed when a conversion could no be successful.
+	 * Exception throwed when a conversion could not be success.
 	 */
         class Invalid_Conversion : Pandora_Strutils::String_Exception {};
 	

pandora_agents/win32/ssh/pandora_ssh_client.cc

@@ -285,7 +285,7 @@ Pandora_Ssh_Client::scpFileFilename (const string remote_filename,
 /** 
  * Get the fingerprint of the remote host.
  * 
- * The finger print is a unical identifier of the host. It's a method
+ * The fingerprint is a unical identifier of the host. It's a method
  * to ensure that the host is the host we supposed.
  *
  * @return The fingerprint of the remote host.

pandora_agents/win32/ssh/pandora_ssh_client.h

@@ -31,7 +31,7 @@ using namespace std;
  * SSH connection classes.
  */
 namespace SSH {
-       /**
+        /**
 	 * A SSH super-class exception.
 	 */
         class SSH_Exception          : public Pandora::Pandora_Exception {
@@ -131,10 +131,6 @@ namespace SSH {
             
                 void disconnect           ();
                                              
-                /* Copy a file using a SSH connection (scp).
-                 * The function receives a filename in the local filesystem and copies all
-                 * its content to the remote host. The remote filename will be the 
-                 * first argument. */
                 void scpFileFilename      (const string remote_filename, 
                                            const string filename);
                                            

pandora_agents/win32/ssh/pandora_ssh_test.cc

@@ -27,7 +27,7 @@ using namespace std;
 using namespace SSH;
 
 /** 
- * Creates a Pandora_SSH_Test.
+ * Creates a Pandora_SSH_Test object.
  *
  * It will read the configuration file and prepares
  * all the information to perform a SSH test.

pandora_agents/win32/windows/pandora_wmi.cc

@@ -149,6 +149,9 @@ Pandora_Wmi::isServiceRunning (string service_name) {
  * @param disk_id Disk drive letter (C.
  * 
  * @return Free space amount in MB.
+ *
+ * @exception Pandora_Wmi_Exception Throwd if an error occured when reading
+ *            from WMI database.
  */
 long
 Pandora_Wmi::getDiskFreeSpace (string disk_id) {
@@ -204,6 +207,9 @@ Pandora_Wmi::getDiskFreeSpace (string disk_id) {
  * @param cpu_id CPU identifier.
  * 
  * @return The usage percentage of the CPU.
+ *
+ * @exception Pandora_Wmi_Exception Throwd if an error occured when reading
+ *            from WMI database.
  */
 int
 Pandora_Wmi::getCpuUsagePercentage (int cpu_id) {
@@ -252,6 +258,8 @@ Pandora_Wmi::getCpuUsagePercentage (int cpu_id) {
  * Get the amount of free memory in the system
  *
  * @return The amount of free memory in MB.
+ * @exception Pandora_Wmi_Exception Throwd if an error occured when reading
+ *            from WMI database.
  */
 long
 Pandora_Wmi::getFreememory () {

pandora_agents/win32/windows_service.cc

@@ -538,9 +538,6 @@ ErrorStopService (LPTSTR lpszAPI)
         SetWindowsServiceStatus (SERVICE_STOPPED, GetLastError(), 0, 0);
 }
 
-/* Copy the system error message into the buffer provided.
- * The buffer length is indicated in iCount.
- */
 static VOID
 svc_format_message (LPSTR msg, int count)
 {

pandora_agents/win32/windows_service.h

@@ -32,7 +32,7 @@
  * set the init_function and run_function. Then use
  * install function to perform the service installation
  * and the run function on the main function to start it.
- * Notice: A program can have only one object of this class.
+ * Notice: A program should have only one object of this class.
  */
 class Windows_Service {
 private: