summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stefw@gnome.org>2013-01-07 11:01:09 +0100
committerStef Walter <stefw@gnome.org>2013-01-07 11:17:24 +0100
commit6ac5af8deece74c383c912f2003b9650c87317b8 (patch)
treee052b59c96d71e484af671cba78dc53db45cf749
parente2b5bba185c96bf4ecddfe22d34ace02706122b4 (diff)
downloadp11-kit-6ac5af8deece74c383c912f2003b9650c87317b8.tar.gz
Fix documentation warnings.
* P11_KIT_URI_NO_MEMORY is an unexpected state, that will probably never actually be returned. But kept for API compatibility. * make distcheck doc fix
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/p11-kit-sections.txt3
-rw-r--r--p11-kit/uri.c9
3 files changed, 9 insertions, 5 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 530b75a..33690d5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -50,7 +50,7 @@ HTML_IMAGES=
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=p11-kit-config.xml p11-kit-sharing.xml
+content_files=p11-kit-config.xml p11-kit-sharing.xml p11-kit-notes.xml
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
diff --git a/doc/p11-kit-sections.txt b/doc/p11-kit-sections.txt
index bdd0434..f3f32a3 100644
--- a/doc/p11-kit-sections.txt
+++ b/doc/p11-kit-sections.txt
@@ -27,6 +27,7 @@ p11_kit_uri_format
p11_kit_uri_parse
p11_kit_uri_free
p11_kit_uri_message
+P11_KIT_URI_NO_MEMORY
</SECTION>
<SECTION>
@@ -84,4 +85,4 @@ p11_kit_uri_type_t
p11_kit_set_progname
p11_kit_be_quiet
p11_kit_message
-</SECTION> \ No newline at end of file
+</SECTION>
diff --git a/p11-kit/uri.c b/p11-kit/uri.c
index b9eef1f..752d677 100644
--- a/p11-kit/uri.c
+++ b/p11-kit/uri.c
@@ -117,6 +117,12 @@
*/
/**
+ * P11_KIT_URI_NO_MEMORY:
+ *
+ * Unexpected memory allocation failure result. Same as #P11_KIT_URI_UNEXPECTED.
+ */
+
+/**
* P11_KIT_URI_SCHEME:
*
* String of URI scheme for PKCS\#11 URIs.
@@ -468,7 +474,6 @@ uri_take_attribute (P11KitUri *uri, CK_ATTRIBUTE_PTR attr)
*
* Returns: %P11_KIT_URI_OK if the attribute was successfully set.
* %P11_KIT_URI_NOT_FOUND if the attribute was not valid for a URI.
- * %P11_KIT_URI_NO_MEMORY if allocation failed.
*/
int
p11_kit_uri_set_attribute (P11KitUri *uri, CK_ATTRIBUTE_PTR attr)
@@ -933,7 +938,6 @@ format_struct_version (char **string, size_t *length, int *is_first,
* The resulting string should be freed with free().
*
* Returns: %P11_KIT_URI_OK if the URI was formatted successfully.
- * %P11_KIT_URI_NO_MEMORY if memory allocation failed.
*/
int
p11_kit_uri_format (P11KitUri *uri, P11KitUriType uri_type, char **string)
@@ -1276,7 +1280,6 @@ parse_extra_info (const char *name, const char *start, const char *end,
* Returns: %P11_KIT_URI_OK if the URI was parsed successfully.
* %P11_KIT_URI_BAD_SCHEME if this was not a PKCS\#11 URI.
* %P11_KIT_URI_BAD_SYNTAX if the URI syntax was bad.
- * %P11_KIT_URI_NO_MEMORY if memory allocation failed.
* %P11_KIT_URI_BAD_VERSION if a version number was bad.
* %P11_KIT_URI_BAD_ENCODING if the URI encoding was invalid.
*/