Misc fixes in documentation.

11 files changed, 16 insertions, 18 deletions

diff --git a/vmime/body.hpp b/vmime/body.hpp
index 6869bb70..3f2ea483 100644
--- a/vmime/body.hpp
+++ b/vmime/body.hpp
@@ -195,7 +195,7 @@ public:
 	  *
 	  * @param contents new body contents
 	  * @param type type of contents
-	  * @param charset charset of contents
+	  * @param chset charset of contents
 	  */
 	void setContents(ref <const contentHandler> contents, const mediaType& type, const charset& chset);
 
@@ -203,8 +203,8 @@ public:
 	  *
 	  * @param contents new body contents
 	  * @param type type of contents
-	  * @param charset charset of contents
-	  * @param encoding contents encoding
+	  * @param chset charset of contents
+	  * @param enc contents encoding
 	  */
 	void setContents(ref <const contentHandler> contents, const mediaType& type,
 		const charset& chset, const encoding& enc);
diff --git a/vmime/component.hpp b/vmime/component.hpp
index 4c6078f3..f96572b7 100644
--- a/vmime/component.hpp
+++ b/vmime/component.hpp
@@ -149,7 +149,6 @@ public:
 	/** Generate RFC-2822/MIME data for this component, using the default generation context.
 	  *
 	  * @param outputStream output stream
-	  * @param maxLineLength maximum line length for output
 	  * @param curLinePos length of the current line in the output buffer
 	  * @param newLinePos will receive the new line position (length of the last line written)
 	  */
@@ -162,7 +161,6 @@ public:
 	  *
 	  * @param ctx generation context
 	  * @param outputStream output stream
-	  * @param maxLineLength maximum line length for output
 	  * @param curLinePos length of the current line in the output buffer
 	  * @param newLinePos will receive the new line position (length of the last line written)
 	  */
diff --git a/vmime/emailAddress.hpp b/vmime/emailAddress.hpp
index 67ea6948..a16366c7 100644
--- a/vmime/emailAddress.hpp
+++ b/vmime/emailAddress.hpp
@@ -55,7 +55,7 @@ public:
 
 	/** Set the local name of the address.
 	  *
-	  * @param name local name of the address
+	  * @param localName local name of the address
 	  */
 	void setLocalName(const word& localName);
 
@@ -67,7 +67,7 @@ public:
 
 	/** Set the domain name of the address.
 	  *
-	  * @param domain domain name of the address
+	  * @param domainName domain name of the address
 	  */
 	void setDomainName(const word& domainName);
 
diff --git a/vmime/encoding.hpp b/vmime/encoding.hpp
index e4f07b68..cdee1d43 100644
--- a/vmime/encoding.hpp
+++ b/vmime/encoding.hpp
@@ -106,7 +106,7 @@ public:
 	/** Decide which encoding to use based on the specified data and charset.
 	  *
 	  * @param data data used to determine encoding
-	  * @param charset charset of data
+	  * @param chset charset of data
 	  * @param usage context of use of data
 	  * @return suitable encoding for specified data and charset
 	  */
diff --git a/vmime/htmlTextPart.hpp b/vmime/htmlTextPart.hpp
index 77060565..59ed1add 100644
--- a/vmime/htmlTextPart.hpp
+++ b/vmime/htmlTextPart.hpp
@@ -175,7 +175,7 @@ public:
 
 	/** Embed an object and returns a string which identifies it.
 	  * The returned identifier is suitable for use in the 'src' attribute
-	  * of an <img> tag.
+	  * of an &lt;img> tag.
 	  *
 	  * \deprecated Use the addObject() methods which take a 'contentHandler'
 	  * parameter type instead.
@@ -189,7 +189,7 @@ public:
 
 	/** Embed an object and returns a string which identifies it.
 	  * The returned identifier is suitable for use in the 'src' attribute
-	  * of an <img> tag.
+	  * of an &lt;img> tag.
 	  *
 	  * @param data object data
 	  * @param type data type
@@ -200,7 +200,7 @@ public:
 
 	/** Embed an object and returns a string which identifies it.
 	  * The returned identifier is suitable for use in the 'src' attribute
-	  * of an <img> tag.
+	  * of an &lt;img> tag.
 	  *
 	  * @param data object data
 	  * @param enc data encoding
diff --git a/vmime/net/pop3/POP3Utils.hpp b/vmime/net/pop3/POP3Utils.hpp
index c4d595ed..7a2376a1 100644
--- a/vmime/net/pop3/POP3Utils.hpp
+++ b/vmime/net/pop3/POP3Utils.hpp
@@ -58,8 +58,8 @@ public:
 	  *    S: .
 	  *
 	  * @param response raw response string as returned by the server
-	  * @return an associative array which map a message number to its
-	  * data (either UID or size)
+	  * @param result points to an associative array which maps a message
+	  * number to its corresponding data (either UID or size)
 	  */
 	static void parseMultiListOrUidlResponse
 		(ref <POP3Response> response, std::map <int, string>& result);
diff --git a/vmime/security/cert/certificateVerifier.hpp b/vmime/security/cert/certificateVerifier.hpp
index e975ae04..349ab46d 100644
--- a/vmime/security/cert/certificateVerifier.hpp
+++ b/vmime/security/cert/certificateVerifier.hpp
@@ -44,7 +44,7 @@ public:
 	/** Verify that the specified certificate chain is trusted.
 	  *
 	  * @param chain certificate chain
-	  * @param server hostname
+	  * @param hostname server hostname
 	  * @throw exceptions::certificate_verification_exception if one
 	  * or more certificates can not be trusted, or the server identity
 	  * cannot be verified
diff --git a/vmime/security/cert/defaultCertificateVerifier.hpp b/vmime/security/cert/defaultCertificateVerifier.hpp
index 31bf71e5..84e08e64 100644
--- a/vmime/security/cert/defaultCertificateVerifier.hpp
+++ b/vmime/security/cert/defaultCertificateVerifier.hpp
@@ -70,6 +70,7 @@ private:
 	/** Verify a chain of X.509 certificates.
 	  *
 	  * @param chain list of X.509 certificates
+	  * @param hostname server hostname
 	  */
 	void verifyX509(ref <certificateChain> chain, const string& hostname);
 
diff --git a/vmime/text.hpp b/vmime/text.hpp
index 99452e5a..be55bf08 100644
--- a/vmime/text.hpp
+++ b/vmime/text.hpp
@@ -204,7 +204,6 @@ public:
 	  *
 	  * @param ctx generation context
 	  * @param os output stream
-	  * @param maxLineLength maximum line length for output
 	  * @param firstLineOffset the first line length (may be useful if the current output line is not empty)
 	  * @param lastLineLength will receive the length of the last line written
 	  * @param flags encoding flags (see EncodeAndFoldFlags)
diff --git a/vmime/utility/parserInputStreamAdapter.hpp b/vmime/utility/parserInputStreamAdapter.hpp
index ae2b1af9..00d38279 100644
--- a/vmime/utility/parserInputStreamAdapter.hpp
+++ b/vmime/utility/parserInputStreamAdapter.hpp
@@ -41,9 +41,9 @@ class VMIME_EXPORT parserInputStreamAdapter : public seekableInputStream
 {
 public:
 
-	/** @param is input stream to wrap
+	/** @param stream input stream to wrap
 	  */
-	parserInputStreamAdapter(ref <seekableInputStream> inputStream);
+	parserInputStreamAdapter(ref <seekableInputStream> stream);
 
 	ref <seekableInputStream> getUnderlyingStream();
 
diff --git a/vmime/utility/stringUtils.hpp b/vmime/utility/stringUtils.hpp
index e5809ed2..8521092c 100644
--- a/vmime/utility/stringUtils.hpp
+++ b/vmime/utility/stringUtils.hpp
@@ -157,7 +157,7 @@ public:
 
 	/** Unquote the specified string and transform escaped characters.
 	  *
-	  * @param string from which to remove quotes
+	  * @param str string from which to remove quotes
 	  * @return unquoted string
 	  */
 	static const string unquote(const string& str);