* infrastructure for locking added, small cosmetics

[modest] / src / modest-proto.h

diff --git a/src/modest-proto.h b/src/modest-proto.h
index 70cc8b5..17906b9 100644 (file)
--- a/src/modest-proto.h
+++ b/src/modest-proto.h
@@ -1,3 +1,33 @@
+/* Copyright (c) 2006, Nokia Corporation
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * * Neither the name of the Nokia Corporation nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+ * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+
 /* modest-proto.h */
 
 #ifndef __MODEST_PROTO_H__
@@ -17,7 +47,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__*/