Fixed typos in documentation.

src/base.cpp

@@ -70,19 +70,19 @@ const text NULL_TEXT;
 const word NULL_WORD("", vmime::charset(vmime::charsets::US_ASCII));
 
 
-/** Return the library name (eg. "libvmime").
+/** Return the library name (eg: "libvmime").
   *
   * @return library name
   */
 const string libname() { return (VMIME_PACKAGE); }
 
-/** Return the library version (eg. "0.5.2").
+/** Return the library version (eg: "0.5.2").
   *
   * @return library version
   */
 const string libversion() { return (VMIME_VERSION " (" __DATE__ " " __TIME__ ")"); }
 
-/** Return the library API version (eg. "6:1:6").
+/** Return the library API version (eg: "6:1:6").
   *
   * @return library API version
   */

src/header.cpp

@@ -316,7 +316,7 @@ const bool header::isEmpty() const
 }
 
 
-ref <headerField> header::getFieldAt(const int pos)
+const ref <headerField> header::getFieldAt(const int pos)
 {
 	return (m_fields[pos]);
 }

src/object.cpp

@@ -29,6 +29,9 @@
 #include <stdexcept>  // std::runtime_error
 
 
+#ifndef VMIME_BUILDING_DOC
+
+
 namespace vmime
 {
 
@@ -188,3 +191,6 @@ const int object::getWeakRefCount() const
 
 } // vmime
 
+
+#endif // VMIME_BUILDING_DOC
+

src/parameterizedHeaderField.cpp

@@ -504,7 +504,7 @@ const ref <parameter> parameterizedHeaderField::getParameterAt(const int pos)
 }
 
 
-const ref <parameter> parameterizedHeaderField::getParameterAt(const int pos) const
+const ref <const parameter> parameterizedHeaderField::getParameterAt(const int pos) const
 {
 	return (m_params[pos]);
 }
@@ -546,5 +546,5 @@ const std::vector <ref <const component> > parameterizedHeaderField::getChildCom
 }
 
 
-
 } // vmime
+

vmime/header.hpp

@@ -195,7 +195,7 @@ public:
 	  * @param pos position
 	  * @return field at position 'pos'
 	  */
-	ref <headerField> getFieldAt(const int pos);
+	const ref <headerField> getFieldAt(const int pos);
 
 	/** Return the field at the specified position.
 	  *

vmime/parameter.hpp

@@ -85,7 +85,7 @@ public:
 	  * For example, the following code:
 	  *
 	  * <pre>
-	  *    getParameter("creation-date")->getValueAs <vmime::dateTime>()</pre>
+	  *    getParameter("creation-date")->getValueAs <vmime::dateTime>()
 	  * </pre>
 	  *
 	  * is equivalent to:

vmime/parameterizedHeaderField.hpp

@@ -158,7 +158,7 @@ public:
 	  * @param pos position
 	  * @return parameter at position 'pos'
 	  */
-	const ref <parameter> getParameterAt(const int pos) const;
+	const ref <const parameter> getParameterAt(const int pos) const;
 
 	/** Return the parameter list.
 	  *

vmime/text.hpp

@@ -214,11 +214,7 @@ public:
 	/** Decode and unfold text (RFC-2047).
 	  *
 	  * @param in input string
-	  * @param generateInExisting if not NULL, the resulting text will be generated
+	  * @return new text object
-	  * in the specified object instead of a new created object (in this case, the
-	  * function returns the same pointer). Can be used to avoid copying the
-	  * resulting object into an existing object.
-	  * @return new text object or existing object if generateInExisting != NULL
 	  */
 	static ref <text> decodeAndUnfold(const string& in);