[evolution-data-server/openismus-phonenumber-work] libebook-contacts: Document EBookQueryTest

[Mathias Hasselmann <hasselmm src gnome org>]

commit 76bbd210af1ba1e066a32a02106cec5bea23b686
Author: Mathias Hasselmann <mathias openismus com>
Date:   Fri Dec 7 13:37:50 2012 +0100

    libebook-contacts: Document EBookQueryTest

 addressbook/libebook-contacts/e-book-query.h |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/addressbook/libebook-contacts/e-book-query.h b/addressbook/libebook-contacts/e-book-query.h
index 0025617..12a1662 100644
--- a/addressbook/libebook-contacts/e-book-query.h
+++ b/addressbook/libebook-contacts/e-book-query.h
@@ -14,6 +14,27 @@ G_BEGIN_DECLS
 
 typedef struct EBookQuery EBookQuery;
 
+/**
+ * EBookQueryTest:
+ * @E_BOOK_QUERY_IS: look for exact match of the supplied test value
+ * @E_BOOK_QUERY_CONTAINS: check if a field contains the test value
+ * @E_BOOK_QUERY_BEGINS_WITH: check if a field starts with the test value
+ * @E_BOOK_QUERY_ENDS_WITH: check if a field ends with the test value
+ * @E_BOOK_QUERY_EQUALS_PHONE_NUMBER: check that a field and the test value
+ * match exactly when interpreted as phone number, that is after stripping
+ * formatting like dashes, dots and spaces. See E_PHONE_NUMBER_MATCH_EXACT.
+ * @E_BOOK_QUERY_EQUALS_NATIONAL_PHONE_NUMBER: check that a field and the
+ * test value match when interpreted as phone number, except for the
+ * (omitted) country code.
+ * @E_BOOK_QUERY_EQUALS_SHORT_PHONE_NUMBER: check that a field and the test
+ * value match is the sense that both values appear to be phone numbers,
+ * and one might be a part (suffix) of the other.
+ *
+ * The kind of test a query created by e_book_query_field_test() shall perform.
+ *
+ * See also: E_PHONE_NUMBER_MATCH_EXACT, E_PHONE_NUMBER_MATCH_NATIONAL and
+ * E_PHONE_NUMBER_MATCH_SHORT.
+ **/
 typedef enum {
   E_BOOK_QUERY_IS,
   E_BOOK_QUERY_CONTAINS,