Some more class documentation.

src/attachment.hpp

@@ -34,6 +34,9 @@ namespace vmime
 {
 
 
+/** Base class for all types of attachment.
+  */
+
 class attachment
 {
 	friend class messageBuilder;

src/base.cpp

@@ -98,6 +98,8 @@ namespace lineLengthLimits
 
 
 
+#ifndef VMIME_BUILDING_DOC
+
 //
 //  V-Mime Initializer
 // ====================
@@ -133,5 +135,7 @@ public:
 
 initializer theInitializer;
 
+#endif // VMIME_BUILDING_DOC
+
 
 } // vmime

src/charset.cpp

@@ -28,6 +28,8 @@ extern "C"
 {
 	#include <iconv.h>
 
+#ifndef VMIME_BUILDING_DOC
+
 	// HACK: prototypes may differ depending on the compiler and/or system (the
 	// second parameter may or may not be 'const'). This redeclaration is a hack
 	// to have a common prototype "iconv_cast".
@@ -35,6 +37,8 @@ extern "C"
 		size_t *inbytesleft, char* * outbuf, size_t *outbytesleft);
 
 	#define iconv_const ((iconv_const_hack) iconv)
+
+#endif // VMIME_BUILDING_DOC
 }
 
 

src/defaultAttachment.hpp

@@ -29,6 +29,9 @@ namespace vmime
 {
 
 
+/** Default implementation for attachments.
+  */
+
 class defaultAttachment : public attachment
 {
 protected:

src/encoder.hpp

@@ -30,6 +30,9 @@ namespace vmime
 {
 
 
+/** Encode/decode data in different encodings.
+  */
+
 class encoder
 {
 public:

src/encoderQP.cpp

@@ -71,6 +71,8 @@ const unsigned char encoderQP::sm_hexDecodeTable[256] =
 };
 
 
+#ifndef VMIME_BUILDING_DOC
+
 #define QP_ENCODE_HEX(x) \
 	outBuffer[outBufferPos] = '=';                           \
 	outBuffer[outBufferPos + 1] = sm_hexDigits[x >> 4];  \
@@ -78,6 +80,8 @@ const unsigned char encoderQP::sm_hexDecodeTable[256] =
 	outBufferPos += 3;                                       \
 	curCol += 3;
 
+#endif // VMIME_BUILDING_DOC
+
 
 const utility::stream::size_type encoderQP::encode(utility::inputStream& in, utility::outputStream& out)
 {

src/exception.hpp

@@ -30,6 +30,9 @@ namespace vmime
 {
 
 
+/** Base class for VMime exceptions.
+  */
+
 class exception
 {
 private:

src/fileAttachment.hpp

@@ -28,6 +28,9 @@ namespace vmime
 {
 
 
+/** Attachment of type 'file'.
+  */
+
 class fileAttachment : public defaultAttachment
 {
 public:
@@ -35,6 +38,8 @@ public:
 	fileAttachment(const string& filename, const mediaType& type, const text& desc = NULL_TEXT);
 	fileAttachment(const string& filename, const mediaType& type, const encoding& enc, const text& desc = NULL_TEXT);
 
+	/** Stores information about a file attachment.
+	  */
 	class fileInfo
 	{
 	public:
@@ -42,27 +47,102 @@ public:
 		fileInfo();
 		~fileInfo();
 
+		/** Check whether the 'filename' property is present.
+		  *
+		  * @return true if the 'filename' property is set,
+		  * false otherwise
+		  */
 		const bool hasFilename() const;
+
+		/** Return the value of the 'filename' property.
+		  *
+		  * @return file name
+		  */
 		const string& getFilename() const;
+
+		/** Set the value of the 'filename' property.
+		  *
+		  * @param name file name
+		  */
 		void setFilename(const string& name);
 
+		/** Check whether the 'creation-date' property is present.
+		  *
+		  * @return true if the 'creation-date' property is set,
+		  * false otherwise
+		  */
 		const bool hasCreationDate() const;
+
+		/** Return the value of the 'creation-date' property.
+		  *
+		  * @return file creation time
+		  */
 		const datetime& getCreationDate() const;
+
+		/** Set the value of the 'creation-date' property.
+		  *
+		  * @param date file creation time
+		  */
 		void setCreationDate(const datetime& date);
 
+		/** Check whether the 'modification-date' property is present.
+		  *
+		  * @return true if the 'modification-date' property is set,
+		  * false otherwise
+		  */
 		const bool hasModificationDate() const;
+
+		/** Return the value of the 'modification-date' property.
+		  *
+		  * @return file modification time
+		  */
 		const datetime& getModificationDate() const;
+
+		/** Set the value of the 'modification-date' property.
+		  *
+		  * @param date file modification time
+		  */
 		void setModificationDate(const datetime& date);
 
+		/** Check whether the 'read-date' property is set.
+		  *
+		  * @return true if the 'read-date' property is set,
+		  * false otherwise
+		  */
 		const bool hasReadDate() const;
+
+		/** Return the value of the 'read-date' property.
+		  *
+		  * @return file access time
+		  */
 		const datetime& getReadDate() const;
+
+		/** Set the value of the 'read-date' property.
+		  *
+		  * @param date file access time
+		  */
 		void setReadDate(const datetime& date);
 
+		/** Check whether the value of the 'size' property is set.
+		  *
+		  * @return true if the 'size' property is set,
+		  * false otherwise
+		  */
 		const bool hasSize() const;
+
+		/** Return the value of the 'size' property.
+		  *
+		  * @return file size
+		  */
 		const unsigned int getSize() const;
+
+		/** Set the value of the 'size' property.
+		  *
+		  * @param size file size
+		  */
 		void setSize(const unsigned int& size);
 
-	protected:
+	private:
 
 		string* m_filename;
 		unsigned int* m_size;

src/genericField.hpp

@@ -79,6 +79,9 @@ private:
 };
 
 
+/** Generic implementation for headerField with a value of type 'string'.
+  */
+
 template <>
 class genericField <string> : public genericField <typeAdapter <string> >
 {

src/genericParameter.hpp

@@ -79,6 +79,9 @@ private:
 };
 
 
+/** Generic implementation for parameter of type 'string'.
+  */
+
 template <>
 class genericParameter <string> : public genericParameter <typeAdapter <string> >
 {

src/headerFieldFactory.hpp

@@ -46,6 +46,7 @@ protected:
 
 public:
 
+#ifndef VMIME_BUILDING_DOC
 	template <class TYPE>
 	class registerer
 	{
@@ -57,6 +58,7 @@ public:
 			return new TYPE();
 		}
 	};
+#endif // VMIME_BUILDING_DOC
 
 
 	template <class T>

src/messageParser.cpp

@@ -58,6 +58,8 @@ messageParser::~messageParser()
 void messageParser::parse(const message& msg)
 {
 	// Header fields (if field is present, copy its value, else do nothing)
+#ifndef VMIME_BUILDING_DOC
+
 #define TRY_FIELD(var, type, name) \
 	try { var = dynamic_cast<type&>(*msg.getHeader()->findField(name)).getValue(); } \
 	catch (exceptions::no_such_field) { }
@@ -72,6 +74,8 @@ void messageParser::parse(const message& msg)
 
 #undef TRY_FIELD
 
+#endif // VMIME_BUILDING_DOC
+
 	// Date
 	try
 	{

src/messaging/IMAPMessage.cpp

@@ -232,6 +232,8 @@ class structure& IMAPpart::getStructure()
 
 
 
+#ifndef VMIME_BUILDING_DOC
+
 //
 // IMAPMessage_literalHandler
 //
@@ -268,6 +270,8 @@ private:
 	progressionListener* m_progress;
 };
 
+#endif // VMIME_BUILDING_DOC
+
 
 
 //

src/messaging/builtinServices.inl

@@ -17,6 +17,9 @@
 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 //
 
+#ifndef VMIME_BUILDING_DOC
+
+
 #define REGISTER_SERVICE(p_class, p_name) \
 	vmime::messaging::service::initializer <vmime::messaging::p_class> p_name(#p_name)
 
@@ -44,3 +47,5 @@
 	REGISTER_SERVICE(maildirStore, maildir);
 #endif
 
+
+#endif // VMIME_BUILDING_DOC

src/messaging/defaultAuthenticator.hpp

@@ -29,8 +29,10 @@ namespace vmime {
 namespace messaging {
 
 
-/** An auhenticator that simply returns the credentials set in the
+/** Default implementation for authenticator. It simply returns
-  * session properties (named 'username' and 'password').
+  * the credentials set in the session properties (named 'username'
+  * and 'password'). This is the default implementation used if
+  * you do not write your own authenticator object.
   */
 
 class defaultAuthenticator : public authenticator

src/messaging/events.hpp

@@ -34,9 +34,8 @@ class folder;
 namespace events {
 
 
-//
+/** Event about the message count in a folder.
-// messageCountEvent
+  */
-//
 
 class messageCountEvent
 {
@@ -44,8 +43,8 @@ public:
 
 	enum Types
 	{
-		TYPE_ADDED,     // new messages
+		TYPE_ADDED,     /**< New messages have been added. */
-		TYPE_REMOVED    // expunged messages: renumbering
+		TYPE_REMOVED    /**< Messages have been expunged (renumbering). */
 	};
 
 
@@ -65,6 +64,9 @@ private:
 };
 
 
+/** Listener for events about the message count in a folder.
+  */
+
 class messageCountListener
 {
 protected:
@@ -78,9 +80,8 @@ public:
 };
 
 
-//
+/** Event occuring on a message.
-// messageChangedEvent
+  */
-//
 
 class messageChangedEvent
 {
@@ -108,6 +109,9 @@ private:
 };
 
 
+/** Listener for events occuring on a message.
+  */
+
 class messageChangedListener
 {
 protected:
@@ -120,9 +124,8 @@ public:
 };
 
 
-//
+/** Event occuring on a folder.
-// folderEvent
+  */
-//
 
 class folderEvent
 {
@@ -130,9 +133,9 @@ public:
 
 	enum Types
 	{
-		TYPE_CREATED,   // a folder was created
+		TYPE_CREATED,   /**< A folder was created. */
-		TYPE_DELETED,   // a folder was deleted
+		TYPE_DELETED,   /**< A folder was deleted. */
-		TYPE_RENAMED    // a folder was renamed
+		TYPE_RENAMED    /**< A folder was renamed. */
 	};
 
 
@@ -152,6 +155,9 @@ private:
 };
 
 
+/** Listener for events occuring on a folder.
+  */
+
 class folderListener
 {
 protected:

src/messaging/service.hpp

@@ -35,6 +35,9 @@ namespace vmime {
 namespace messaging {
 
 
+/** Base class for messaging services.
+  */
+
 class service
 {
 protected:
@@ -114,6 +117,7 @@ public:
 	  */
 	authenticator* getAuthenticator();
 
+#ifndef VMIME_BUILDING_DOC
 	// Basic service registerer
 	template <class S>
 	class initializer
@@ -126,6 +130,7 @@ public:
 				template registerServiceByProtocol <S>(protocol);
 		}
 	};
+#endif // VMIME_BUILDING_DOC
 
 private:
 

src/messaging/serviceInfos.hpp

@@ -30,6 +30,9 @@ namespace vmime {
 namespace messaging {
 
 
+/** Stores information about a messaging service.
+  */
+
 class serviceInfos
 {
 	friend class serviceFactory;

src/messaging/simpleAuthenticator.hpp

@@ -28,6 +28,9 @@ namespace vmime {
 namespace messaging {
 
 
+/** Basic implementation for an authenticator.
+  */
+
 class simpleAuthenticator : public authenticator
 {
 public:

src/messaging/socket.hpp

@@ -28,6 +28,9 @@ namespace vmime {
 namespace messaging {
 
 
+/** Interface for connecting to servers.
+  */
+
 class socket
 {
 public:
@@ -81,6 +84,9 @@ public:
 };
 
 
+/** A class to create 'socket' objects.
+  */
+
 class socketFactory
 {
 public:

src/messaging/timeoutHandler.hpp

@@ -54,6 +54,9 @@ public:
 };
 
 
+/** A class to create 'timeoutHandler' objects.
+  */
+
 class timeoutHandlerFactory
 {
 public:

src/parameterFactory.hpp

@@ -46,6 +46,7 @@ protected:
 
 public:
 
+#ifndef VMIME_BUILDING_DOC
 	template <class TYPE>
 	class registerer
 	{
@@ -57,6 +58,7 @@ public:
 			return new TYPE();
 		}
 	};
+#endif // VMIME_BUILDING_DOC
 
 
 	template <class T>

src/platformDependant.hpp

@@ -40,14 +40,17 @@ namespace vmime
 {
 
 
-/** The link between your application and VMime. It offers an interface to
+/** Allow setting or getting the current platform handler.
-  * access platform-dependant objects: sockets, date/time, file system, etc.
   */
 
 class platformDependant
 {
 public:
 
+	/** Handles all platform-dependant operations. It offers an interface to
+	  * access platform-dependant objects: sockets, date/time, file system, etc.
+	  */
+
 	class handler
 	{
 	public:

src/textPartFactory.hpp

@@ -44,6 +44,7 @@ protected:
 
 	NameMap m_nameMap;
 
+#ifndef VMIME_BUILDING_DOC
 	template <class TYPE>
 	class registerer
 	{
@@ -55,6 +56,7 @@ protected:
 			return new TYPE();
 		}
 	};
+#endif // VMIME_BUILDING_DOC
 
 public:
 

src/typeAdapter.hpp

@@ -30,6 +30,9 @@ namespace vmime
 {
 
 
+/** An adapter to allow any type being treated as a 'component'.
+  */
+
 template <class TYPE>
 class typeAdapter : public component
 {

src/utility/file.hpp

@@ -198,7 +198,7 @@ public:
 };
 
 
-/** Constructs file objects.
+/** Constructs 'file' objects.
   */
 
 class fileSystemFactory

vmime.doxygen

@@ -333,18 +333,18 @@ WARN_FORMAT            = "$file:$line: $text"
 # and error messages should be written. If left blank the output is written
 # to stderr.
 
-WARN_LOGFILE           = 
+WARN_LOGFILE           =
 
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 
-# The INPUT tag can be used to specify the files and/or directories that contain 
+# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or 
+# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories 
+# directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ./src/ ./src/messaging/ ./src/utility/
+INPUT                  = ./src/ ./src/messaging/ ./src/utility/ ./src/platforms/posix/
 
 # If the value of the INPUT tag contains directories, you can use the
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -376,45 +376,45 @@ EXCLUDE_SYMLINKS       = NO
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
 # certain files from those directories.
 
-EXCLUDE_PATTERNS       = */config.hpp */IMAPTag* */IMAPParser* */IMAPUtils* */IMAPConnection* */md5* */smartPtr* */authHelper.*
+EXCLUDE_PATTERNS       = */config.hpp */IMAPTag* */IMAPParser* */IMAPUtils* */IMAPConnection* */md5* */smartPtr* */authHelper* */maildirUtils*
 
-# The EXAMPLE_PATH tag can be used to specify one or more files or 
+# The EXAMPLE_PATH tag can be used to specify one or more files or
-# directories that contain example code fragments that are included (see 
+# directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = 
+EXAMPLE_PATH           =
 
-# If the value of the EXAMPLE_PATH tag contains directories, you can use the 
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
-# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
-# and *.h) to filter out the source-files in the directories. If left 
+# and *.h) to filter out the source-files in the directories. If left
 # blank all files are included.
 
-EXAMPLE_PATTERNS       = 
+EXAMPLE_PATTERNS       =
 
-# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
-# searched for input files to be used with the \include or \dontinclude 
+# searched for input files to be used with the \include or \dontinclude
-# commands irrespective of the value of the RECURSIVE tag. 
+# commands irrespective of the value of the RECURSIVE tag.
 # Possible values are YES and NO. If left blank NO is used.
 
 EXAMPLE_RECURSIVE      = NO
 
-# The IMAGE_PATH tag can be used to specify one or more files or 
+# The IMAGE_PATH tag can be used to specify one or more files or
-# directories that contain image that are included in the documentation (see 
+# directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             =
 
-# The INPUT_FILTER tag can be used to specify a program that doxygen should 
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
-# invoke to filter for each input file. Doxygen will invoke the filter program 
+# invoke to filter for each input file. Doxygen will invoke the filter program
-# by executing (via popen()) the command <filter> <input-file>, where <filter> 
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
-# is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
-# input file. Doxygen will then use the output that the filter program writes 
+# input file. Doxygen will then use the output that the filter program writes
 # to standard output.
 
-INPUT_FILTER           = 
+INPUT_FILTER           =
 
-# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
-# INPUT_FILTER) will be used to filter the input files when producing source 
+# INPUT_FILTER) will be used to filter the input files when producing source
 # files to browse (i.e. when SOURCE_BROWSER is set to YES).
 
 FILTER_SOURCE_FILES    = NO
@@ -423,7 +423,7 @@ FILTER_SOURCE_FILES    = NO
 # configuration options related to source browsing
 #---------------------------------------------------------------------------
 
-# If the SOURCE_BROWSER tag is set to YES then a list of source files will 
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
 # be generated. Documented entities will be cross-referenced with these sources.
 
 SOURCE_BROWSER         = NO
@@ -508,59 +508,59 @@ HTML_HEADER            =
 
 HTML_FOOTER            =
 
-# The HTML_STYLESHEET tag can be used to specify a user defined cascading 
+# The HTML_STYLESHEET tag can be used to specify a user defined cascading
-# style sheet that is used by each HTML page. It can be used to 
+# style sheet that is used by each HTML page. It can be used to
-# fine-tune the look of the HTML output. If the tag is left blank doxygen 
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
 # will generate a default style sheet
 
-HTML_STYLESHEET        = 
+HTML_STYLESHEET        =
 
-# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
-# files or namespaces will be aligned in HTML using tables. If set to 
+# files or namespaces will be aligned in HTML using tables. If set to
 # NO a bullet list will be used.
 
 HTML_ALIGN_MEMBERS     = YES
 
-# If the GENERATE_HTMLHELP tag is set to YES, additional index files 
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
-# will be generated that can be used as input for tools like the 
+# will be generated that can be used as input for tools like the
-# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) 
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
 # of the generated HTML documentation.
 
 GENERATE_HTMLHELP      = NO
 
-# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
-# be used to specify the file name of the resulting .chm file. You 
+# be used to specify the file name of the resulting .chm file. You
-# can add a path in front of the file if the result should not be 
+# can add a path in front of the file if the result should not be
 # written to the html output dir.
 
-CHM_FILE               = 
+CHM_FILE               =
 
-# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
-# be used to specify the location (absolute path including file name) of 
+# be used to specify the location (absolute path including file name) of
-# the HTML help compiler (hhc.exe). If non empty doxygen will try to run 
+# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
 # the html help compiler on the generated index.hhp.
 
-HHC_LOCATION           = 
+HHC_LOCATION           =
 
-# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
-# controls if a separate .chi index file is generated (YES) or that 
+# controls if a separate .chi index file is generated (YES) or that
 # it should be included in the master .chm file (NO).
 
 GENERATE_CHI           = NO
 
-# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
-# controls whether a binary table of contents is generated (YES) or a 
+# controls whether a binary table of contents is generated (YES) or a
 # normal table of contents (NO) in the .chm file.
 
 BINARY_TOC             = NO
 
-# The TOC_EXPAND flag can be set to YES to add extra items for group members 
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
 # to the contents of the Html help documentation and to the tree view.
 
 TOC_EXPAND             = NO
 
-# The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
-# top of each HTML page. The value NO (the default) enables the index and 
+# top of each HTML page. The value NO (the default) enables the index and
 # the value YES disables it.
 
 DISABLE_INDEX          = NO
@@ -612,46 +612,46 @@ LATEX_CMD_NAME         = latex
 
 MAKEINDEX_CMD_NAME     = makeindex
 
-# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
 # LaTeX documents. This may be useful for small projects and may help to
 # save some trees in general.
 
 COMPACT_LATEX          = NO
 
-# The PAPER_TYPE tag can be used to set the paper type that is used 
+# The PAPER_TYPE tag can be used to set the paper type that is used
-# by the printer. Possible values are: a4, a4wide, letter, legal and 
+# by the printer. Possible values are: a4, a4wide, letter, legal and
 # executive. If left blank a4wide will be used.
 
 PAPER_TYPE             = a4wide
 
-# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 # packages that should be included in the LaTeX output.
 
-EXTRA_PACKAGES         = 
+EXTRA_PACKAGES         =
 
-# The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
-# the generated latex document. The header should contain everything until 
+# the generated latex document. The header should contain everything until
-# the first chapter. If it is left blank doxygen will generate a 
+# the first chapter. If it is left blank doxygen will generate a
 # standard header. Notice: only use this tag if you know what you are doing!
 
-LATEX_HEADER           = 
+LATEX_HEADER           =
 
-# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
-# is prepared for conversion to pdf (using ps2pdf). The pdf file will 
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
-# contain links (just like the HTML output) instead of page references 
+# contain links (just like the HTML output) instead of page references
 # This makes the output suitable for online browsing using a pdf viewer.
 
 PDF_HYPERLINKS         = NO
 
-# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
-# plain latex in the generated Makefile. Set this option to YES to get a 
+# plain latex in the generated Makefile. Set this option to YES to get a
 # higher quality PDF documentation.
 
 USE_PDFLATEX           = NO
 
-# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
-# command to the generated LaTeX files. This will instruct LaTeX to keep 
+# command to the generated LaTeX files. This will instruct LaTeX to keep
-# running if errors occur, instead of asking the user for help. 
+# running if errors occur, instead of asking the user for help.
 # This option is also used when generating formulas in HTML.
 
 LATEX_BATCHMODE        = NO
@@ -660,68 +660,68 @@ LATEX_BATCHMODE        = NO
 # configuration options related to the RTF output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
-# The RTF output is optimised for Word 97 and may not look very pretty with 
+# The RTF output is optimised for Word 97 and may not look very pretty with
 # other RTF readers or editors.
 
 GENERATE_RTF           = NO
 
-# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
 # put in front of it. If left blank `rtf' will be used as the default path.
 
 RTF_OUTPUT             = rtf
 
-# If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
-# RTF documents. This may be useful for small projects and may help to 
+# RTF documents. This may be useful for small projects and may help to
 # save some trees in general.
 
 COMPACT_RTF            = NO
 
-# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
-# will contain hyperlink fields. The RTF file will 
+# will contain hyperlink fields. The RTF file will
-# contain links (just like the HTML output) instead of page references. 
+# contain links (just like the HTML output) instead of page references.
-# This makes the output suitable for online browsing using WORD or other 
+# This makes the output suitable for online browsing using WORD or other
-# programs which support those fields. 
+# programs which support those fields.
 # Note: wordpad (write) and others do not support links.
 
 RTF_HYPERLINKS         = NO
 
-# Load stylesheet definitions from file. Syntax is similar to doxygen's 
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
-# config file, i.e. a series of assigments. You only have to provide 
+# config file, i.e. a series of assigments. You only have to provide
 # replacements, missing definitions are set to their default value.
 
-RTF_STYLESHEET_FILE    = 
+RTF_STYLESHEET_FILE    =
 
-# Set optional variables used in the generation of an rtf document. 
+# Set optional variables used in the generation of an rtf document.
 # Syntax is similar to doxygen's config file.
 
-RTF_EXTENSIONS_FILE    = 
+RTF_EXTENSIONS_FILE    =
 
 #---------------------------------------------------------------------------
 # configuration options related to the man page output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 # generate man pages
 
 GENERATE_MAN           = NO
 
-# The MAN_OUTPUT tag is used to specify where the man pages will be put. 
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
-# If a relative path is entered the value of OUTPUT_DIRECTORY will be 
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
 # put in front of it. If left blank `man' will be used as the default path.
 
 MAN_OUTPUT             = man
 
-# The MAN_EXTENSION tag determines the extension that is added to 
+# The MAN_EXTENSION tag determines the extension that is added to
 # the generated man pages (default is the subroutine's section .3)
 
 MAN_EXTENSION          = .3
 
-# If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
-# then it will generate one additional man file for each entity 
+# then it will generate one additional man file for each entity
-# documented in the real man page(s). These additional files 
+# documented in the real man page(s). These additional files
-# only source the real man page, but without them the man command 
+# only source the real man page, but without them the man command
 # would be unable to find the correct page. The default is NO.
 
 MAN_LINKS              = NO
@@ -730,34 +730,34 @@ MAN_LINKS              = NO
 # configuration options related to the XML output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_XML tag is set to YES Doxygen will 
+# If the GENERATE_XML tag is set to YES Doxygen will
-# generate an XML file that captures the structure of 
+# generate an XML file that captures the structure of
-# the code including all documentation. Note that this 
+# the code including all documentation. Note that this
-# feature is still experimental and incomplete at the 
+# feature is still experimental and incomplete at the
 # moment.
 
 GENERATE_XML           = NO
 
-# The XML_SCHEMA tag can be used to specify an XML schema, 
+# The XML_SCHEMA tag can be used to specify an XML schema,
-# which can be used by a validating XML parser to check the 
+# which can be used by a validating XML parser to check the
 # syntax of the XML files.
 
-XML_SCHEMA             = 
+XML_SCHEMA             =
 
-# The XML_DTD tag can be used to specify an XML DTD, 
+# The XML_DTD tag can be used to specify an XML DTD,
-# which can be used by a validating XML parser to check the 
+# which can be used by a validating XML parser to check the
 # syntax of the XML files.
 
-XML_DTD                = 
+XML_DTD                =
 
 #---------------------------------------------------------------------------
 # configuration options for the AutoGen Definitions output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
-# generate an AutoGen Definitions (see autogen.sf.net) file 
+# generate an AutoGen Definitions (see autogen.sf.net) file
-# that captures the structure of the code including all 
+# that captures the structure of the code including all
-# documentation. Note that this feature is still experimental 
+# documentation. Note that this feature is still experimental
 # and incomplete at the moment.
 
 GENERATE_AUTOGEN_DEF   = NO
@@ -766,10 +766,10 @@ GENERATE_AUTOGEN_DEF   = NO
 # configuration options related to the Perl module output
 #---------------------------------------------------------------------------
 
-# If the GENERATE_PERLMOD tag is set to YES Doxygen will 
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
-# generate a Perl module file that captures the structure of 
+# generate a Perl module file that captures the structure of
-# the code including all documentation. Note that this 
+# the code including all documentation. Note that this
-# feature is still experimental and incomplete at the 
+# feature is still experimental and incomplete at the
 # moment.
 
 #GENERATE_PERLMOD       = NO
@@ -793,251 +793,251 @@ GENERATE_AUTOGEN_DEF   = NO
 # This is useful so different doxyrules.make files included by the same
 # Makefile don't overwrite each other's variables.
 
-#PERLMOD_MAKEVAR_PREFIX = 
+#PERLMOD_MAKEVAR_PREFIX =
 
 #---------------------------------------------------------------------------
-# Configuration options related to the preprocessor   
+# Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 
-# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
-# evaluate all C-preprocessor directives found in the sources and include 
+# evaluate all C-preprocessor directives found in the sources and include
 # files.
 
 ENABLE_PREPROCESSING   = YES
 
-# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
-# names in the source code. If set to NO (the default) only conditional 
+# names in the source code. If set to NO (the default) only conditional
-# compilation will be performed. Macro expansion can be done in a controlled 
+# compilation will be performed. Macro expansion can be done in a controlled
 # way by setting EXPAND_ONLY_PREDEF to YES.
 
 MACRO_EXPANSION        = YES
 
-# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
-# then the macro expansion is limited to the macros specified with the 
+# then the macro expansion is limited to the macros specified with the
 # PREDEFINED and EXPAND_AS_PREDEFINED tags.
 
 EXPAND_ONLY_PREDEF     = NO
 
-# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
 # in the INCLUDE_PATH (see below) will be search if a #include is found.
 
 SEARCH_INCLUDES        = YES
 
-# The INCLUDE_PATH tag can be used to specify one or more directories that 
+# The INCLUDE_PATH tag can be used to specify one or more directories that
-# contain include files that are not input files but should be processed by 
+# contain include files that are not input files but should be processed by
 # the preprocessor.
 
-INCLUDE_PATH           = 
+INCLUDE_PATH           =
 
-# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
-# patterns (like *.h and *.hpp) to filter out the header-files in the 
+# patterns (like *.h and *.hpp) to filter out the header-files in the
-# directories. If left blank, the patterns specified with FILE_PATTERNS will 
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
 # be used.
 
-INCLUDE_FILE_PATTERNS  = 
+INCLUDE_FILE_PATTERNS  =
 
-# The PREDEFINED tag can be used to specify one or more macro names that 
+# The PREDEFINED tag can be used to specify one or more macro names that
-# are defined before the preprocessor is started (similar to the -D option of 
+# are defined before the preprocessor is started (similar to the -D option of
-# gcc). The argument of the tag is a list of macros of the form: name 
+# gcc). The argument of the tag is a list of macros of the form: name
-# or name=definition (no spaces). If the definition and the = are 
+# or name=definition (no spaces). If the definition and the = are
 # omitted =1 is assumed.
 
-PREDEFINED             = 
+PREDEFINED             = VMIME_BUILDING_DOC
 
-# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
-# this tag can be used to specify a list of macro names that should be expanded. 
+# this tag can be used to specify a list of macro names that should be expanded.
-# The macro definition that is found in the sources will be used. 
+# The macro definition that is found in the sources will be used.
 # Use the PREDEFINED tag if you want to use a different macro definition.
 
-EXPAND_AS_DEFINED      = 
+EXPAND_AS_DEFINED      =
 
-# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
-# doxygen's preprocessor will remove all function-like macros that are alone 
+# doxygen's preprocessor will remove all function-like macros that are alone
-# on a line, have an all uppercase name, and do not end with a semicolon. Such 
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
-# function macros are typically used for boiler-plate code, and will confuse the 
+# function macros are typically used for boiler-plate code, and will confuse the
 # parser if not removed.
 
 SKIP_FUNCTION_MACROS   = YES
 
 #---------------------------------------------------------------------------
-# Configuration::addtions related to external references   
+# Configuration::addtions related to external references
 #---------------------------------------------------------------------------
 
 # The TAGFILES tag can be used to specify one or more tagfiles.
 
-TAGFILES               = 
+TAGFILES               =
 
-# When a file name is specified after GENERATE_TAGFILE, doxygen will create 
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.
 
-GENERATE_TAGFILE       = 
+GENERATE_TAGFILE       =
 
-# If the ALLEXTERNALS tag is set to YES all external classes will be listed 
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
-# in the class index. If set to NO only the inherited external classes 
+# in the class index. If set to NO only the inherited external classes
 # will be listed.
 
 ALLEXTERNALS           = NO
 
-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
-# in the modules index. If set to NO, only the current project's groups will 
+# in the modules index. If set to NO, only the current project's groups will
 # be listed.
 
 EXTERNAL_GROUPS        = YES
 
-# The PERL_PATH should be the absolute path and name of the perl script 
+# The PERL_PATH should be the absolute path and name of the perl script
 # interpreter (i.e. the result of `which perl').
 
 PERL_PATH              = /usr/bin/perl
 
 #---------------------------------------------------------------------------
-# Configuration options related to the dot tool   
+# Configuration options related to the dot tool
 #---------------------------------------------------------------------------
 
-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
-# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
+# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
-# super classes. Setting the tag to NO turns the diagrams off. Note that this 
+# super classes. Setting the tag to NO turns the diagrams off. Note that this
-# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
+# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
 # recommended to install and use dot, since it yield more powerful graphs.
 
 CLASS_DIAGRAMS         = YES
 
-# If set to YES, the inheritance and collaboration graphs will hide 
+# If set to YES, the inheritance and collaboration graphs will hide
-# inheritance and usage relations if the target is undocumented 
+# inheritance and usage relations if the target is undocumented
 # or is not a class.
 
 HIDE_UNDOC_RELATIONS   = YES
 
-# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
-# available from the path. This tool is part of Graphviz, a graph visualization 
+# available from the path. This tool is part of Graphviz, a graph visualization
-# toolkit from AT&T and Lucent Bell Labs. The other options in this section 
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
 # have no effect if this option is set to NO (the default)
 
 HAVE_DOT               = YES
 
-# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and 
+# will generate a graph for each documented class showing the direct and
-# indirect inheritance relations. Setting this tag to YES will force the 
+# indirect inheritance relations. Setting this tag to YES will force the
 # the CLASS_DIAGRAMS tag to NO.
 
 CLASS_GRAPH            = YES
 
-# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
-# will generate a graph for each documented class showing the direct and 
+# will generate a graph for each documented class showing the direct and
-# indirect implementation dependencies (inheritance, containment, and 
+# indirect implementation dependencies (inheritance, containment, and
 # class references variables) of the class with other documented classes.
 
 COLLABORATION_GRAPH    = YES
 
-# If set to YES, the inheritance and collaboration graphs will show the 
+# If set to YES, the inheritance and collaboration graphs will show the
 # relations between templates and their instances.
 
 TEMPLATE_RELATIONS     = YES
 
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
-# tags are set to YES then doxygen will generate a graph for each documented 
+# tags are set to YES then doxygen will generate a graph for each documented
-# file showing the direct and indirect include dependencies of the file with 
+# file showing the direct and indirect include dependencies of the file with
 # other documented files.
 
 INCLUDE_GRAPH          = YES
 
-# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
-# HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
-# documented header file showing the documented files that directly or 
+# documented header file showing the documented files that directly or
 # indirectly include this file.
 
 INCLUDED_BY_GRAPH      = YES
 
-# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
 # will graphical hierarchy of all classes instead of a textual one.
 
 GRAPHICAL_HIERARCHY    = YES
 
-# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
 # generated by dot. Possible values are png, jpg, or gif
 # If left blank png will be used.
 
 DOT_IMAGE_FORMAT       = png
 
-# The tag DOT_PATH can be used to specify the path where the dot tool can be 
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
 # found. If left blank, it is assumed the dot tool can be found on the path.
 
-DOT_PATH               = 
+DOT_PATH               =
 
-# The DOTFILE_DIRS tag can be used to specify one or more directories that 
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
-# contain dot files that are included in the documentation (see the 
+# contain dot files that are included in the documentation (see the
 # \dotfile command).
 
-DOTFILE_DIRS           = 
+DOTFILE_DIRS           =
 
-# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width 
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
-# this value, doxygen will try to truncate the graph, so that it fits within 
+# this value, doxygen will try to truncate the graph, so that it fits within
-# the specified constraint. Beware that most browsers cannot cope with very 
+# the specified constraint. Beware that most browsers cannot cope with very
 # large images.
 
 MAX_DOT_GRAPH_WIDTH    = 1024
 
-# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height 
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
-# (in pixels) of the graphs generated by dot. If a graph becomes larger than 
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
-# this value, doxygen will try to truncate the graph, so that it fits within 
+# this value, doxygen will try to truncate the graph, so that it fits within
-# the specified constraint. Beware that most browsers cannot cope with very 
+# the specified constraint. Beware that most browsers cannot cope with very
 # large images.
 
 MAX_DOT_GRAPH_HEIGHT   = 1024
 
-# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
-# generate a legend page explaining the meaning of the various boxes and 
+# generate a legend page explaining the meaning of the various boxes and
 # arrows in the dot generated graphs.
 
 GENERATE_LEGEND        = YES
 
-# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
-# remove the intermedate dot files that are used to generate 
+# remove the intermedate dot files that are used to generate
 # the various graphs.
 
 DOT_CLEANUP            = YES
 
 #---------------------------------------------------------------------------
-# Configuration::addtions related to the search engine   
+# Configuration::addtions related to the search engine
 #---------------------------------------------------------------------------
 
-# The SEARCHENGINE tag specifies whether or not a search engine should be 
+# The SEARCHENGINE tag specifies whether or not a search engine should be
 # used. If set to NO the values of all tags below this one will be ignored.
 
 SEARCHENGINE           = NO
 
-# The CGI_NAME tag should be the name of the CGI script that 
+# The CGI_NAME tag should be the name of the CGI script that
-# starts the search engine (doxysearch) with the correct parameters. 
+# starts the search engine (doxysearch) with the correct parameters.
 # A script with this name will be generated by doxygen.
 
 #CGI_NAME               = search.cgi
 
-# The CGI_URL tag should be the absolute URL to the directory where the 
+# The CGI_URL tag should be the absolute URL to the directory where the
-# cgi binaries are located. See the documentation of your http daemon for 
+# cgi binaries are located. See the documentation of your http daemon for
 # details.
 
-#CGI_URL                = 
+#CGI_URL                =
 
-# The DOC_URL tag should be the absolute URL to the directory where the 
+# The DOC_URL tag should be the absolute URL to the directory where the
-# documentation is located. If left blank the absolute path to the 
+# documentation is located. If left blank the absolute path to the
 # documentation, with file:// prepended to it, will be used.
 
-#DOC_URL                = 
+#DOC_URL                =
 
-# The DOC_ABSPATH tag should be the absolute path to the directory where the 
+# The DOC_ABSPATH tag should be the absolute path to the directory where the
-# documentation is located. If left blank the directory on the local machine 
+# documentation is located. If left blank the directory on the local machine
 # will be used.
 
-#DOC_ABSPATH            = 
+#DOC_ABSPATH            =
 
-# The BIN_ABSPATH tag must point to the directory where the doxysearch binary 
+# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
 # is installed.
 
 #BIN_ABSPATH            = /usr/local/bin/
 
-# The EXT_DOC_PATHS tag can be used to specify one or more paths to 
+# The EXT_DOC_PATHS tag can be used to specify one or more paths to
-# documentation generated for other projects. This allows doxysearch to search 
+# documentation generated for other projects. This allows doxysearch to search
 # the documentation for these projects as well.
 
-#EXT_DOC_PATHS          = 
+#EXT_DOC_PATHS          =