From cffdc6caf55ec944144cc87f669e04d80e5045a2 Mon Sep 17 00:00:00 2001
From: Vincent Richard <vincent@vincent-richard.net>
Date: Sat, 5 Nov 2005 09:47:08 +0000
Subject: [PATCH] Fixed typos in documentation.

---
 src/base.cpp                       | 6 +++---
 src/header.cpp                     | 2 +-
 src/object.cpp                     | 6 ++++++
 src/parameterizedHeaderField.cpp   | 4 ++--
 vmime/header.hpp                   | 2 +-
 vmime/parameter.hpp                | 2 +-
 vmime/parameterizedHeaderField.hpp | 2 +-
 vmime/text.hpp                     | 6 +-----
 8 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/src/base.cpp b/src/base.cpp
index 8170a9b8..ff0258f9 100644
--- a/src/base.cpp
+++ b/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
   */
diff --git a/src/header.cpp b/src/header.cpp
index 503ee16b..719e2456 100644
--- a/src/header.cpp
+++ b/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]);
 }
diff --git a/src/object.cpp b/src/object.cpp
index 72f631e9..3b29b755 100644
--- a/src/object.cpp
+++ b/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
+
diff --git a/src/parameterizedHeaderField.cpp b/src/parameterizedHeaderField.cpp
index 771fcbb1..c58a4c78 100644
--- a/src/parameterizedHeaderField.cpp
+++ b/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
+
diff --git a/vmime/header.hpp b/vmime/header.hpp
index bb806fc7..9f10ed41 100644
--- a/vmime/header.hpp
+++ b/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.
 	  *
diff --git a/vmime/parameter.hpp b/vmime/parameter.hpp
index 8ac7e82c..964d666c 100644
--- a/vmime/parameter.hpp
+++ b/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:
diff --git a/vmime/parameterizedHeaderField.hpp b/vmime/parameterizedHeaderField.hpp
index bc1dc5be..76e500fc 100644
--- a/vmime/parameterizedHeaderField.hpp
+++ b/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.
 	  *
diff --git a/vmime/text.hpp b/vmime/text.hpp
index 8da6d9e0..b3817754 100644
--- a/vmime/text.hpp
+++ b/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
-	  * 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
+	  * @return new text object
 	  */
 	static ref <text> decodeAndUnfold(const string& in);