[patch] fix API documentation (typo and misleading call samples)

documentation-type+cast+ME-error.patch (text/plain), 3.07 KB, created by Raphaël Droz on 2013-01-20 18:09:56 UTC

diff -Pr -u doc.old/libvformat-1.texi doc/libvformat-1.texi
--- doc.old/libvformat-1.texi	2013-01-18 02:31:02.362032907 +0100
+++ doc/libvformat-1.texi	2013-01-20 18:58:50.204913546 +0100
@@ -183,22 +183,22 @@
 p_qualifier argument in the arglist).  Valid calls might be:
 
 @example
-  vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "N", NULL);
+  vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "N", (char*)0);
     - find and return "N" properties.  If there are none, return FALSE.
 
-  vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "TEL", "WORK", NULL);
+  vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "TEL", "WORK", (char*)0);
     - find and return "TEL" entries qualified by the "work" attribute
       (ie. work phone numbers). If there are none, return FALSE.
 
-  vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", NULL);
+  vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", (char*)0);
     - find and return work phone number.  The entry is automatically
     added if not pre-existing.
 
-  vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", NULL);
+  vf_get_property(&p_out, p_object, VFGP_GET, "ME", "TEL", "WORK", (char*)0);
     - find and return work phone numbers in the group identifier by the "ME"
     identifier.  The entry is automatically added if not pre-existing.
 
-  vf_get_property(&p_out, p_object, VFGP_FIND, "ME", "*", NULL);
+  vf_get_property(&p_out, p_object, VFGP_FIND, "ME", "*", (char*)0);
     - effectively enumerates all entries in the "ME" group.
 @end example
 
diff -Pr -u doc.old/vf_get_property.3 doc/vf_get_property.3
--- doc.old/vf_get_property.3	2013-01-18 02:31:02.362032907 +0100
+++ doc/vf_get_property.3	2013-01-20 19:00:46.307453940 +0100
@@ -55,26 +55,26 @@
 of arguments must be NULL terminated (hence the appearance of the
 p_qualifier argument in the arglist).  Valid calls might be:
 
-vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "N", NULL);
+vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "N", (char*)0);
 .br
 - Find and return "N" properties.  If there are none, return FALSE.
 
-Vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "TEL", "WORK", NULL);
+vf_get_property(&p_out, p_object, VFGP_FIND, NULL, "TEL", "WORK", (char*)0);
 .br
 - Find and return "TEL" entries qualified by the "work" attribute
 (ie. Work phone numbers). If there are none, return FALSE.
 
-Vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", NULL);
+vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", (char*)0);
 .br
 - Find and return work phone number.  The entry is automatically
 added if not pre-existing.
 
-Vf_get_property(&p_out, p_object, VFGP_GET, NULL, "TEL", "WORK", NULL);
+vf_get_property(&p_out, p_object, VFGP_GET, "ME", "TEL", "WORK", (char*)0);
 .br
 - Find and return work phone numbers in the group identifier by the "ME"
 identifier.  The entry is automatically added if not pre-existing.
 
-Vf_get_property(&p_out, p_object, VFGP_FIND, "ME", "*", NULL);
+vf_get_property(&p_out, p_object, VFGP_FIND, "ME", "*", (char*)0);
 .br
 - Effectively enumerates all entries in the "ME" group.