From: Alessandro Maraschini <alessandro.maraschini@elsagdatamat.com>
Date: Thu, 16 Dec 2004 14:53:59 +0000 (+0000)
Subject: comments added/modifed for documention generation
X-Git-Tag: glite-deployment-lb_R_0_3_0~25
X-Git-Url: http://scientific.zcu.cz/git/?a=commitdiff_plain;h=19ff60ee4ede1053917cf220759909467d622f0c;p=jra1mw.git

comments added/modifed for documention generation
---

diff --git a/org.glite.wms-utils.exception/interface/glite/wmsutils/exception/Exception.h b/org.glite.wms-utils.exception/interface/glite/wmsutils/exception/Exception.h
index 7ba0fda..95cdcf6 100644
--- a/org.glite.wms-utils.exception/interface/glite/wmsutils/exception/Exception.h
+++ b/org.glite.wms-utils.exception/interface/glite/wmsutils/exception/Exception.h
@@ -54,8 +54,7 @@ class Exception : public std::exception{
 	* @param code the code representing the thrown exception
 	* @param exception the name of the thrown exception
 	* @param method the name of the method that raised the exception
-	* @param source The source that raised the exception (could be the file path, the class Name, etc etc)
-	* @param line_number the number of the line in the file that raised the exception(if the source has been given as a file)  */
+	* @param source The source that raised the exception (could be the file path, the class Name, etc etc) */
 	Exception ( const std::string& source, const std::string& method,  int code,  const std::string& exception);
 
 	/**
@@ -114,15 +113,25 @@ class Exception : public std::exception{
 	*/
 	virtual void push_back (  const std::string& source, int line_number,  const std::string& method   ) ;
   protected:
+		/** Empty constructor*/
 		Exception();
+		/**  integer error code representing the cause of the error */
 		int                   error_code;
+		/**  string exception message representation*/
 		std::string          error_message ;
+		/**  line number where the exception was raised */
 		int                   line;
+		/** The name of the file where the exception was raised */
 		std::string          source_file;
+		/** the name of the exception */
 		std::string          exception_name;
+		/** the name of the method where the expceiton was raised */
 		std::string          method_name ;
+		/** a string representation of the stacktrace */
 		std::string          stack;
+		/** the actual internal stacktrace representation */
 		std::vector< std::string> stack_strings ;
+		/** the name of the ancestor exception */
 		std::string          ancestor ;
 }; //End  Exception Class
 }}}  // Closing namespace