diff --git a/ChangeLog b/ChangeLog index 75564f31c4..8508712e88 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2006-05-14 Derek Atkins + + * src/lib/libqof/qof/qofquery.h: + Fix the documentation of qof_query_merge for degenerate cases. + 2006-05-12 Derek Atkins * goffice-config.h.in: diff --git a/lib/libqof/qof/qofquery.h b/lib/libqof/qof/qofquery.h index 28f13c242d..fdfeaa8b81 100644 --- a/lib/libqof/qof/qofquery.h +++ b/lib/libqof/qof/qofquery.h @@ -276,8 +276,11 @@ QofQuery * qof_query_invert(QofQuery *q); * search for the set type. If neither query has the search-type set, * the result will be unset as well. * - * This will return a newly allocated QofQuery object, or NULL - * on error. Free it with qof_query_destroy() when no longer needed. + * This will return a newly allocated QofQuery object, or NULL on + * error. Free it with qof_query_destroy() when no longer needed. + * Note that if either input query is NULL then the returned query is + * NOT newly allocated -- it will return the non-NULL query. You + * only need to call this function when both q1 and q2 are non-NULL. */ QofQuery * qof_query_merge(QofQuery *q1, QofQuery *q2, QofQueryOp op);