GpgFrontend/vmime
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Missing code documentation.

Browse Source
This commit is contained in:
Vincent Richard 2013-11-24 19:30:45 +01:00
parent f91b1ec6a0
commit 7b3e79ca52
2 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
vmime/header.hpp
View File

@ -101,6 +101,8 @@ public:
* Field name is case-insensitive. * Field name is case-insensitive.
* If no field is found, NULL is returned. * If no field is found, NULL is returned.
* *
* @param fieldName name of field to return (eg: "X-Mailer" or "From",
* common field names are available in the vmime::fields namespace)
* @return first field with the specified name, or NULL if no field * @return first field with the specified name, or NULL if no field
* with this name was found * with this name was found
*/ */
@ -111,6 +113,9 @@ public:
* If no field is found, or the field is not of the specified type, * If no field is found, or the field is not of the specified type,
* NULL is returned. * NULL is returned.
* *
* @param fieldName name of field whose value is to be returned
* (eg: "X-Mailer" or "From", common field names are available in
* the vmime::fields namespace)
* @return first field with the specified name, or NULL if no field * @return first field with the specified name, or NULL if no field
* with this name was found * with this name was found
*/ */
@ -125,6 +130,8 @@ public:
* If no field is found, or the field value is not of the specified * If no field is found, or the field value is not of the specified
* type, NULL is returned. * type, NULL is returned.
* *
* @param fieldName name of field to return (eg: "X-Mailer" or "From",
* common field names are available in the vmime::fields namespace)
* @return value of the first field with the specified name, or NULL * @return value of the first field with the specified name, or NULL
* if no field with this name was found, or the value is not of the * if no field with this name was found, or the value is not of the
* specified type * specified type
@ -143,6 +150,8 @@ public:
/** Find all fields that match the specified name. /** Find all fields that match the specified name.
* If no field is found, an empty vector is returned. * If no field is found, an empty vector is returned.
* *
* @param fieldName name of field to return (eg: "X-Mailer" or "From",
* common field names are available in the vmime::fields namespace)
* @return list of fields with the specified name * @return list of fields with the specified name
*/ */
std::vector <shared_ptr <headerField> > findAllFields(const string& fieldName); std::vector <shared_ptr <headerField> > findAllFields(const string& fieldName);
@ -151,6 +160,8 @@ public:
* If no field is found, one will be created and inserted into * If no field is found, one will be created and inserted into
* the header. * the header.
* *
* @param fieldName name of field to return (eg: "X-Mailer" or "From",
* common field names are available in the vmime::fields namespace)
* @return first field with the specified name or a new field * @return first field with the specified name or a new field
* if no field is found * if no field is found
*/ */

7
vmime/parameterizedHeaderField.hpp
View File

@ -57,14 +57,16 @@ public:
parameterizedHeaderField& operator=(const parameterizedHeaderField& other); parameterizedHeaderField& operator=(const parameterizedHeaderField& other);
/** Checks whether (at least) one parameter with this name exists. /** Checks whether (at least) one parameter with this name exists.
* Parameter name is case-insensitive.
* *
* @param paramName parameter name
* @return true if at least one parameter with the specified name * @return true if at least one parameter with the specified name
* exists, or false otherwise * exists, or false otherwise
*/ */
bool hasParameter(const string& paramName) const; bool hasParameter(const string& paramName) const;
/** Find the first parameter that matches the specified name. /** Find the first parameter that matches the specified name. Parameter name
* If no parameter is found, NULL is returned. * is case-insensitive. If no parameter is found, NULL is returned.
* *
* @param paramName parameter name * @param paramName parameter name
* @return first parameter with the specified name, or NULL if * @return first parameter with the specified name, or NULL if
@ -73,6 +75,7 @@ public:
shared_ptr <parameter> findParameter(const string& paramName) const; shared_ptr <parameter> findParameter(const string& paramName) const;
/** Find the first parameter that matches the specified name. /** Find the first parameter that matches the specified name.
* Parameter name is case-insensitive.
* If no parameter is found, one will be created and inserted into * If no parameter is found, one will be created and inserted into
* the parameter list. * the parameter list.
* *