diff options
author | Ross Burton <ross@linux.intel.com> | 2010-08-11 18:30:34 +0100 |
---|---|---|
committer | Ross Burton <ross@linux.intel.com> | 2010-08-11 18:30:34 +0100 |
commit | 17c5d2f3407c108c680b672c52df7fc4919548d6 (patch) | |
tree | 7d928b6b8ef586b5c0db0d6322e4bbdcb5121141 | |
parent | 30bd53e4fb2d1f61fa54a66e2f5dfdce39b8a67b (diff) |
Small documentation fixes
-rw-r--r-- | docs/reference/rest/rest-sections.txt | 6 | ||||
-rw-r--r-- | rest-extras/flickr-proxy-call.c | 8 | ||||
-rw-r--r-- | rest/rest-param.c | 8 | ||||
-rw-r--r-- | rest/rest-proxy-call.c | 10 |
4 files changed, 23 insertions, 9 deletions
diff --git a/docs/reference/rest/rest-sections.txt b/docs/reference/rest/rest-sections.txt index bda95d7..23664d1 100644 --- a/docs/reference/rest/rest-sections.txt +++ b/docs/reference/rest/rest-sections.txt @@ -68,7 +68,6 @@ rest_proxy_call_error_quark <SECTION> <FILE>oauth2-proxy</FILE> <TITLE>OAuth2Proxy</TITLE> -OAuth2ProxyPrivate OAuth2Proxy oauth2_proxy_new oauth2_proxy_new_with_token @@ -79,6 +78,7 @@ oauth2_proxy_set_access_token oauth2_proxy_extract_access_token <SUBSECTION Standard> OAuth2ProxyClass +OAuth2ProxyPrivate OAUTH2_PROXY OAUTH2_IS_PROXY OAUTH2_TYPE_PROXY @@ -229,7 +229,6 @@ FLICKR_PROXY_CALL_GET_CLASS <SECTION> <FILE>flickr-proxy</FILE> <TITLE>FlickrProxy</TITLE> -FlickrProxyPrivate FlickrProxy FLICKR_PROXY_ERROR flickr_proxy_new @@ -245,6 +244,7 @@ flickr_proxy_new_upload flickr_proxy_new_upload_for_file <SUBSECTION Standard> FlickrProxyClass +FlickrProxyPrivate FLICKR_PROXY FLICKR_IS_PROXY FLICKR_TYPE_PROXY @@ -272,7 +272,6 @@ LASTFM_PROXY_CALL_GET_CLASS <SECTION> <FILE>lastfm-proxy</FILE> <TITLE>LastfmProxy</TITLE> -LastfmProxyPrivate LastfmProxy LASTFM_PROXY_ERROR lastfm_proxy_new @@ -286,6 +285,7 @@ lastfm_proxy_build_login_url lastfm_proxy_is_successful <SUBSECTION Standard> LastfmProxyClass +LastfmProxyPrivate LASTFM_PROXY LASTFM_IS_PROXY LASTFM_TYPE_PROXY diff --git a/rest-extras/flickr-proxy-call.c b/rest-extras/flickr-proxy-call.c index ad8b74e..a9bc6f7 100644 --- a/rest-extras/flickr-proxy-call.c +++ b/rest-extras/flickr-proxy-call.c @@ -109,7 +109,13 @@ flickr_proxy_call_class_init (FlickrProxyCallClass *klass) call_class->prepare = _prepare; obj_class->set_property = flickr_proxy_call_set_property; - pspec = g_param_spec_boolean ("upload", "upload", NULL, + /** + * FlickrProxyCall:upload: + * + * Set if the call should be sent to the photo upload endpoint and not the + * general-purpose endpoint. + */ + pspec = g_param_spec_boolean ("upload", "upload", "upload", FALSE, G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS); g_object_class_install_property (obj_class, PROP_UPLOAD, pspec); } diff --git a/rest/rest-param.c b/rest/rest-param.c index 9ed3237..29b209e 100644 --- a/rest/rest-param.c +++ b/rest/rest-param.c @@ -237,6 +237,14 @@ rest_param_get_file_name (RestParam *param) return param->filename; } +/** + * rest_param_is_string: + * @param: a valid #RestParam + * + * Determine if the parameter is a string value, i.e. the content type is "text/plain". + * + * Returns: %TRUE if the parameter is a string, %FALSE otherwise. + */ gboolean rest_param_is_string (RestParam *param) { diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c index 6090135..3517a56 100644 --- a/rest/rest-proxy-call.c +++ b/rest/rest-proxy-call.c @@ -948,12 +948,12 @@ rest_proxy_call_sync (RestProxyCall *call, } /** - * rest_proxy_call_lookup_response_header + * rest_proxy_call_lookup_response_header: * @call: The #RestProxyCall * @header: The name of the header to lookup. * - * Returns: The string value of the header @header or NULL if that header is - * not present or there are no headers. + * Get the string value of the header @header or %NULL if that header is not + * present or there are no headers. */ const gchar * rest_proxy_call_lookup_response_header (RestProxyCall *call, @@ -974,10 +974,10 @@ rest_proxy_call_lookup_response_header (RestProxyCall *call, } /** - * rest_proxy_call_get_response_headers + * rest_proxy_call_get_response_headers: * @call: The #RestProxyCall * - * Returns: A pointer to a hash table of headers. This hash table must not be + * Returns: pointer to a hash table of headers. This hash table must not be * changed. You should call g_hash_table_unref() when you have finished with * it. */ |