/dev/tomkiewicz/e2ee: f1eeb0d0cea5: Request API: fill in the com...

[Tomasz Wasilczyk]

Changeset: f1eeb0d0cea5c94ee3204b486c2b50dfbab412c4
Author:	 Tomasz Wasilczyk <twasilczyk at pidgin.im>
Date:	 2013-10-23 21:00 +0200
Branch:	 default
URL: https://hg.pidgin.im/dev/tomkiewicz/e2ee/rev/f1eeb0d0cea5

Description:

Request API: fill in the comments

diffstat:

 libpurple/request.h |  26 ++++++++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)

diffs (48 lines):

diff --git a/libpurple/request.h b/libpurple/request.h
--- a/libpurple/request.h
+++ b/libpurple/request.h
@@ -516,6 +516,13 @@ const GList *purple_request_fields_get_r
 const GList *purple_request_fields_get_validatable(
 	const PurpleRequestFields *fields);
 
+/**
+ * Returns a list of all fields with sensitivity callback added.
+ *
+ * @param fields The fields list.
+ *
+ * @constreturn The list of fields with automatic sensitivity callback.
+ */
 const GList *
 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields);
 
@@ -889,11 +896,30 @@ gboolean purple_request_field_is_validat
  */
 gboolean purple_request_field_is_valid(PurpleRequestField *field, gchar **errmsg);
 
+/**
+ * Sets field editable.
+ *
+ * @param field     The field.
+ * @param sensitive TRUE if the field should be sensitive for user input.
+ */
 void purple_request_field_set_sensitive(PurpleRequestField *field,
 	gboolean sensitive);
 
+/**
+ * Checks, if field is editable.
+ *
+ * @param field The field.
+ *
+ * @return TRUE, if the field is sensitive for user input.
+ */
 gboolean purple_request_field_is_sensitive(PurpleRequestField *field);
 
+/**
+ * Sets the callback, used to determine if the field should be editable.
+ *
+ * @param field The field.
+ * @param cb    The callback.
+ */
 void purple_request_field_set_sensitivity_cb(PurpleRequestField *field,
 	PurpleRequestFieldSensitivityCb cb);