Fix the documentation of qof_query_merge for degenerate cases.

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@14042 57a11ea4-9604-0410-9ed3-97b8803252fd

ChangeLog

@@ -1,3 +1,8 @@
+2006-05-14  Derek Atkins  <derek@ihtfp.com>
+
+	* src/lib/libqof/qof/qofquery.h:
+	  Fix the documentation of qof_query_merge for degenerate cases.
+
 2006-05-12  Derek Atkins <derek@ihtfp.com>
 
 	* goffice-config.h.in:

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);