[casacore] r21241 committed - Fixed documentation doxygen warnings

0 views

Skip to first unread message

casa...@googlecode.com

unread,

Apr 12, 2012, 9:38:10 AM4/12/12

to casacor...@googlegroups.com

Revision: 21241
Author: gervandiepen
Date: Thu Apr 12 06:37:37 2012
Log: Fixed documentation doxygen warnings

http://code.google.com/p/casacore/source/detail?r=21241

Modified:
/trunk/components/SpectralComponents/CompiledSpectralElement.h
/trunk/components/SpectralComponents/GaussianMultipletSpectralElement.h
/trunk/components/SpectralComponents/GaussianSpectralElement.h
/trunk/components/SpectralComponents/LorentzianSpectralElement.h
/trunk/components/SpectralComponents/PCFSpectralElement.h
/trunk/components/SpectralComponents/PolynomialSpectralElement.h
/trunk/images/Images/ImageAttrGroup.h
/trunk/images/Images/ImageAttrGroupCasa.h
/trunk/images/Images/ImageAttrGroupHDF5.h
/trunk/scimath/Functionals/Lorentzian1D.h

=======================================
--- /trunk/components/SpectralComponents/CompiledSpectralElement.h Mon Apr
2 05:00:20 2012
+++ /trunk/components/SpectralComponents/CompiledSpectralElement.h Thu Apr
12 06:37:37 2012
@@ -43,7 +43,7 @@
// </reviewed>

// <prerequisite>
-// <li> <linkto module=SpectralElement>SpectralElement</linkto> module
-// <li> <linkto
module=GaussianSpectralElement>CompiledSpectralElement</linkto> module
-// <li> <linkto
module=CompiledSpectralElement>CompiledSpectralElement</linkto> module
+// <li> <linkto class=SpectralElement>SpectralElement</linkto> class
+// <li> <linkto
class=GaussianSpectralElement>CompiledSpectralElement</linkto> class
+// <li> <linkto
class=CompiledSpectralElement>CompiledSpectralElement</linkto> class
// </prerequisite>
//
// <etymology>
=======================================
--- /trunk/components/SpectralComponents/GaussianSpectralElement.h Mon Apr
2 05:00:20 2012
+++ /trunk/components/SpectralComponents/GaussianSpectralElement.h Thu Apr
12 06:37:37 2012
@@ -42,7 +42,7 @@
// </reviewed>

// <prerequisite>
-// <li> <linkto module=SpectralElement>SpectralElement</linkto> module
+// <li> <linkto class=SpectralElement>SpectralElement</linkto> class
// </prerequisite>
//
// <etymology>
=======================================
--- /trunk/images/Images/ImageAttrGroup.h Tue Apr 3 05:53:02 2012
+++ /trunk/images/Images/ImageAttrGroup.h Thu Apr 12 06:37:37 2012
@@ -66,7 +66,7 @@
// the attributes of a group. It can get and put the attribute values, as
well
// as their unit and measure info (type and reference frame type).
// For HDF5 images the unit is stored in attribute
<src>attrname>_UNIT</src>
-// and the measure info in <rc>attrname>_MEASINFO</src>. For casacore
images
+// and the measure info in <src>attrname>_MEASINFO</src>. For casacore
images
// that info is stored as TableMeasure info in the column keywords.
//
// All attributes in a group must have the same number of values, where
each
@@ -141,11 +141,11 @@
virtual Record getDataRow (uInt rownr) = 0;

// Get the possible units of the values.
- // An empty vector is returned if no units.
+ // An empty vector is returned if the attribute has no units.
virtual Vector<String> getUnit (const String& attrName) = 0;

// Get the possible measure info as type and Ref.
- // An empty vector is returned if no MEASINFO exists.
+ // An empty vector is returned if the attribute has no MEASINFO.
virtual Vector<String> getMeasInfo (const String& attrName) = 0;

// Put the data of the given attribute in the given row.
=======================================
--- /trunk/images/Images/ImageAttrGroupCasa.h Tue Apr 3 05:53:02 2012
+++ /trunk/images/Images/ImageAttrGroupCasa.h Thu Apr 12 06:37:37 2012
@@ -93,11 +93,11 @@
virtual Record getDataRow (uInt rownr);

// Get the possible measure info as type and Ref.
- // An empty vector is returned if no MEASINFO.
+ // An empty vector is returned if the attribute has no MEASINFO.
virtual Vector<String> getMeasInfo (const String& attrName);

// Put the data of the given attribute.
=======================================
--- /trunk/images/Images/ImageAttrGroupHDF5.h Tue Apr 3 05:53:02 2012
+++ /trunk/images/Images/ImageAttrGroupHDF5.h Thu Apr 12 06:37:37 2012
@@ -96,12 +96,12 @@
// Get the data of all attributes in a rows.
virtual Record getDataRow (uInt rownr);

- // Get the possible units of the values (stored as <name>_UNIT).
- // An empty vector is returned if no units.
+ // Get the possible units of the values (stored as attrName_UNIT).
+ // An empty vector is returned if the attribute has no units.
virtual Vector<String> getUnit (const String& attrName);

- // Get the possible measure info as type and Ref (stored as
<name>_MEASINFO).
- // An empty vector is returned if no MEASINFO.
+ // Get the possible measure info as type,Ref (stored as
attrName_MEASINFO).
+ // An empty vector is returned if the attribute has no MEASINFO.
virtual Vector<String> getMeasInfo (const String& attrName);

// Put the data of the given attribute.
=======================================
--- /trunk/scimath/Functionals/Lorentzian1D.h Thu Mar 22 23:58:05 2012
+++ /trunk/scimath/Functionals/Lorentzian1D.h Thu Apr 12 06:37:37 2012
@@ -54,10 +54,9 @@

// <etymology>
// A Lorentzian1D functional is designed exclusively for calculating a
-// Lorentzian (or Normal) distribution in one dimension. Other classes
exist
-// for calculating these functions in two
-// (<linkto class=Lorentzian2D>Lorentzian2D</linkto>) and N
-// (<linkto class=LorentzianND>LorentzianND</linkto>) dimensions.
+// Lorentzian (or Normal) distribution in one dimension. Future classes can
+// be used for calculating these functions in two and N dimensions
+// (Lorentzian2D and LorentzianND).
// </etymology>