* added GTKdoc compliant documentation

[modest] / src / modest-proto.h

diff --git a/src/modest-proto.h b/src/modest-proto.h
index 70cc8b5..003f054 100644 (file)
--- a/src/modest-proto.h
+++ b/src/modest-proto.h
@@ -17,7 +17,24 @@ enum {
 };
 typedef gint ModestProtoType;
 
+/**
+ * modest_proto_is_valid:
+ * @proto: a string describing the protocol
+ *
+ * checks if proto is a valid protocol
+ *
+ * Returns: TRUE if proto is valid, FALSE otherwise
+ */
 gboolean         modest_proto_is_valid     (const gchar *proto);
+
+/**
+ * modest_proto_type:
+ * @proto: a string describing the protocol
+ *
+ * converts the string proto into a ModestProtoType
+ *
+ * Returns: a valid ModestProtoType corresponding to proto
+ */
 ModestProtoType  modest_proto_type         (const gchar *proto);
 
 #endif /*__MODEST_SERVER_PROTO_H__*/