diff options
Diffstat (limited to 'src/messaging')
-rw-r--r-- | src/messaging/IMAPMessage.cpp | 4 | ||||
-rw-r--r-- | src/messaging/builtinServices.inl | 5 | ||||
-rw-r--r-- | src/messaging/defaultAuthenticator.hpp | 6 | ||||
-rw-r--r-- | src/messaging/events.hpp | 34 | ||||
-rw-r--r-- | src/messaging/service.hpp | 5 | ||||
-rw-r--r-- | src/messaging/serviceInfos.hpp | 3 | ||||
-rw-r--r-- | src/messaging/simpleAuthenticator.hpp | 3 | ||||
-rw-r--r-- | src/messaging/socket.hpp | 6 | ||||
-rw-r--r-- | src/messaging/timeoutHandler.hpp | 3 |
9 files changed, 53 insertions, 16 deletions
diff --git a/src/messaging/IMAPMessage.cpp b/src/messaging/IMAPMessage.cpp index 36f51257..fc19d248 100644 --- a/src/messaging/IMAPMessage.cpp +++ b/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 + // diff --git a/src/messaging/builtinServices.inl b/src/messaging/builtinServices.inl index f1934ff9..77809234 100644 --- a/src/messaging/builtinServices.inl +++ b/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 diff --git a/src/messaging/defaultAuthenticator.hpp b/src/messaging/defaultAuthenticator.hpp index 9480ec56..dcd0f297 100644 --- a/src/messaging/defaultAuthenticator.hpp +++ b/src/messaging/defaultAuthenticator.hpp @@ -29,8 +29,10 @@ namespace vmime { namespace messaging { -/** An auhenticator that simply returns the credentials set in the - * session properties (named 'username' and 'password'). +/** Default implementation for authenticator. It simply returns + * 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 diff --git a/src/messaging/events.hpp b/src/messaging/events.hpp index d51ca2d0..f2ab9e29 100644 --- a/src/messaging/events.hpp +++ b/src/messaging/events.hpp @@ -34,9 +34,8 @@ class folder; namespace events { -// -// messageCountEvent -// +/** Event about the message count in a folder. + */ class messageCountEvent { @@ -44,8 +43,8 @@ public: enum Types { - TYPE_ADDED, // new messages - TYPE_REMOVED // expunged messages: renumbering + TYPE_ADDED, /**< New messages have been added. */ + 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: }; -// -// messageChangedEvent -// +/** Event occuring on a message. + */ class messageChangedEvent { @@ -108,6 +109,9 @@ private: }; +/** Listener for events occuring on a message. + */ + class messageChangedListener { protected: @@ -120,9 +124,8 @@ public: }; -// -// folderEvent -// +/** Event occuring on a folder. + */ class folderEvent { @@ -130,9 +133,9 @@ public: enum Types { - TYPE_CREATED, // a folder was created - TYPE_DELETED, // a folder was deleted - TYPE_RENAMED // a folder was renamed + TYPE_CREATED, /**< A folder was created. */ + TYPE_DELETED, /**< A folder was deleted. */ + TYPE_RENAMED /**< A folder was renamed. */ }; @@ -152,6 +155,9 @@ private: }; +/** Listener for events occuring on a folder. + */ + class folderListener { protected: diff --git a/src/messaging/service.hpp b/src/messaging/service.hpp index cfab3611..e6aa372c 100644 --- a/src/messaging/service.hpp +++ b/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: diff --git a/src/messaging/serviceInfos.hpp b/src/messaging/serviceInfos.hpp index 3215ab7d..d9ba7510 100644 --- a/src/messaging/serviceInfos.hpp +++ b/src/messaging/serviceInfos.hpp @@ -30,6 +30,9 @@ namespace vmime { namespace messaging { +/** Stores information about a messaging service. + */ + class serviceInfos { friend class serviceFactory; diff --git a/src/messaging/simpleAuthenticator.hpp b/src/messaging/simpleAuthenticator.hpp index 4fbbbf0a..8789c40a 100644 --- a/src/messaging/simpleAuthenticator.hpp +++ b/src/messaging/simpleAuthenticator.hpp @@ -28,6 +28,9 @@ namespace vmime { namespace messaging { +/** Basic implementation for an authenticator. + */ + class simpleAuthenticator : public authenticator { public: diff --git a/src/messaging/socket.hpp b/src/messaging/socket.hpp index 4cf69536..257a459c 100644 --- a/src/messaging/socket.hpp +++ b/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: diff --git a/src/messaging/timeoutHandler.hpp b/src/messaging/timeoutHandler.hpp index a7675b79..1d366084 100644 --- a/src/messaging/timeoutHandler.hpp +++ b/src/messaging/timeoutHandler.hpp @@ -54,6 +54,9 @@ public: }; +/** A class to create 'timeoutHandler' objects. + */ + class timeoutHandlerFactory { public: |