From: Carsten Niehaus <cniehaus@gmx.de>
Date: Wed, 22 Feb 2006 10:38:39 +0000 (+0000)
Subject: apidox and removal of a useless method
X-Git-Tag: v3.80.2~157
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=f665553557e94618db1af494a230a2bf0f49de76;p=libqmvoc.git

apidox and removal of a useless method

svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=512350
---

diff --git a/libscience/element.h b/libscience/element.h
index 9145f79..c3889ee 100644
--- a/libscience/element.h
+++ b/libscience/element.h
@@ -44,13 +44,13 @@ class Element
 		virtual ~Element();
 		
 		/**
-		 * Sdd the ChemicalDataObject @p o to this Element
+		 * Add the ChemicalDataObject @p o to this Element
 		 * @param o the ChemicalDataObject to be added
 		 */
 		void addData( ChemicalDataObject*o );
 
 		/**
-		 * Sdd a ChemicalDataObject with @p value of @p type to this
+		 * Add a ChemicalDataObject with @p value of @p type to this
 		 * Element
 		 * @param value the QVariant to be added
 		 * @param type the BlueObelisk type to be added
diff --git a/libscience/isotope.cpp b/libscience/isotope.cpp
index 0d38c38..7d4ac40 100644
--- a/libscience/isotope.cpp
+++ b/libscience/isotope.cpp
@@ -33,11 +33,6 @@ Isotope::~Isotope()
 {
 }
 
-ChemicalDataObject* Isotope::data() const
-{
-	return m_mass;
-}
-
 void Isotope::addData( ChemicalDataObject* o )
 {
 	if ( o->type() == ChemicalDataObject::exactMass )
@@ -53,7 +48,6 @@ void Isotope::addData( ChemicalDataObject* o )
 	else if ( o->type() == ChemicalDataObject::halfLife )
 		m_halflife = o;
 
-	//FIXME in the future there should be real CDOs. But CDO only supports one datavalue...
 	if ( o->type() == ChemicalDataObject::betaplusDecay )
 		m_betaplus = o;
 	else if (  o->type() == ChemicalDataObject::betaminusDecay )
diff --git a/libscience/isotope.h b/libscience/isotope.h
index db6789e..d3211be 100644
--- a/libscience/isotope.h
+++ b/libscience/isotope.h
@@ -36,22 +36,49 @@ class Isotope
 		 * Constructs a new empty isotope.
 		 */
 		Isotope();
+
+		/**
+		 * Destructor
+		 */
 		virtual ~Isotope();
 
+		/**
+		 * This struct stores the information how the nucleons in the 
+		 * isotopes are split into neutrons and protons.
+		 */
 		struct Nucleons
 		{
+			/**
+			 * the number of neutrons of the isotope
+			 */
 			int neutrons;
+			
+			/**
+			 * the number of protons of the isotope
+			 */
 			int protons;
 		};
 
-		ChemicalDataObject* data() const;
-
+		/**
+		 * @return the mass of the isotope
+		 */
 		double mass() const;
 
+		/**
+		 * @return the errormargin ( delta mass ) of the isotope
+		 */
 		QString errorMargin() const;
 
+		/**
+		 * If the isotope belongs to Iron, this method will return "26"
+		 * @return the number of the element the isotope belongs to
+		 */
 		int parentElementNumber() const;
 
+		/**
+		 * If the isotope belongs to Iron, this method will return "Fe"
+		 * @return the symbol of the element the isotope belongs to
+		 */
 		QString parentElementSymbol() const;
 
 		QString spin() const;
@@ -100,18 +127,22 @@ class Isotope
 			return m_alpha;
 		}
 
+		/**
+		 * This enum stores the different kinds of decay
+		 */
 		enum Decay
 		{
-			ALPHA,
-			BETAPLUS,
-			BETAMINUS,
-			EC
+			ALPHA/**<alpha decay*/,
+			BETAPLUS/**<beta plus decay*/,
+			BETAMINUS/**<beta minus decay*/,
+			EC/**ec decay*/
 		};
 
 		/**
-		 * @return the number of neutrons of the Isotope after the decay
+		 * @return the nucleons of neutrons of the Isotope after the decay
 		 */
 		Isotope::Nucleons nucleonsAfterDecay( Decay kind );
+
 	private:
 		/**
 		 * the symbol of the element the isotope belongs to