Commit e184358b authored by Zach Goldberg's avatar Zach Goldberg Committed by Ross Burton
Browse files

Fix gtk-doc format on all functions in public GUPnP API

http://bugzilla.openedhand.com/show_bug.cgi?id=2086
parent ded2b9d2
......@@ -269,7 +269,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPContextManagerPrivate));
/**
* GSSDPClient:main-context
* GSSDPClient:main-context:
*
* The #GMainContext to pass to created #GUPnPContext objects. Set to
* NULL to use the default.
......@@ -287,7 +287,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContextManager:port
* GUPnPContextManager:port:
*
* @port: Port to create contexts for, or 0 if you don't care what
* port is used by #GUPnPContext objects created by this object.
......@@ -306,7 +306,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContextManager:context-manager
* GUPnPContextManager:context-manager:
*
* The actual GUPnPContextManager implementation used. This is an
* internal property and therefore Application developer should just
......@@ -328,7 +328,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContextManager::context-available
* GUPnPContextManager::context-available:
* @context_manager: The #GUPnPContextManager that received the signal
* @context: The now available #GUPnPContext
*
......@@ -347,7 +347,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
GUPNP_TYPE_CONTEXT);
/**
* GUPnPContextManager::context-unavailable
* GUPnPContextManager::context-unavailable:
* @context_manager: The #GUPnPContextManager that received the signal
* @context: The now unavailable #GUPnPContext
*
......@@ -367,7 +367,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
}
/**
* gupnp_context_manager_new
* gupnp_context_manager_new:
* @port: Port to create contexts for, or 0 if you don't care what port is used.
* @main_context: GMainContext to pass to created GUPnPContext objects.
*
......@@ -409,7 +409,7 @@ gupnp_context_manager_new (GMainContext *main_context,
}
/**
* gupnp_context_manager_manage_control_point
* gupnp_context_manager_manage_control_point:
* @manager: A #GUPnPContextManager
* @control_point: The #GUPnPControlPoint to be taken care of
*
......@@ -431,7 +431,7 @@ gupnp_context_manager_manage_control_point (GUPnPContextManager *manager,
}
/**
* gupnp_context_manager_manage_root_device
* gupnp_context_manager_manage_root_device:
* @manager: A #GUPnPContextManager
* @root_device: The #GUPnPRootDevice to be taken care of
*
......
......@@ -279,7 +279,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPContextPrivate));
/**
* GUPnPContext:port
* GUPnPContext:port:
*
* The port to run on. Set to 0 if you don't care what port to run on.
**/
......@@ -297,7 +297,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContext:server
* GUPnPContext:server:
*
* The #SoupServer HTTP server used by GUPnP.
**/
......@@ -314,7 +314,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContext:session
* GUPnPContext:session:
*
* The #SoupSession object used by GUPnP.
**/
......@@ -331,7 +331,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPContext:subscription-timeout
* GUPnPContext:subscription-timeout:
*
* The preferred subscription timeout: the number of seconds after
* which subscriptions are renewed. Set to '0' if subscriptions
......@@ -354,7 +354,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
}
/**
* gupnp_context_get_session
* gupnp_context_get_session:
* @context: A #GUPnPContext
*
* Get the #SoupSession object that GUPnP is using.
......@@ -385,7 +385,7 @@ default_server_handler (SoupServer *server,
}
/**
* gupnp_context_get_server
* gupnp_context_get_server:
* @context: A #GUPnPContext
*
* Get the #SoupServer HTTP server that GUPnP is using.
......@@ -454,7 +454,7 @@ _gupnp_context_get_server_url (GUPnPContext *context)
}
/**
* gupnp_context_new
* gupnp_context_new:
* @main_context: A #GMainContext, or %NULL to use the default one
* @interface: The network interface to use, or %NULL to auto-detect.
* @port: Port to run on, or 0 if you don't care what port is used.
......@@ -480,7 +480,7 @@ gupnp_context_new (GMainContext *main_context,
}
/**
* gupnp_context_get_host_ip
* gupnp_context_get_host_ip:
* @context: A #GUPnPContext
*
* Get the IP address we advertise ourselves as using.
......@@ -498,7 +498,7 @@ gupnp_context_get_host_ip (GUPnPContext *context)
}
/**
* gupnp_context_get_port
* gupnp_context_get_port:
* @context: A #GUPnPContext
*
* Get the port that the SOAP server is running on.
......@@ -517,7 +517,7 @@ gupnp_context_get_port (GUPnPContext *context)
}
/**
* gupnp_context_set_subscription_timeout
* gupnp_context_set_subscription_timeout:
* @context: A #GUPnPContext
* @timeout: Event subscription timeout in seconds
*
......@@ -537,7 +537,7 @@ gupnp_context_set_subscription_timeout (GUPnPContext *context,
}
/**
* gupnp_context_get_subscription_timeout
* gupnp_context_get_subscription_timeout:
* @context: A #GUPnPContext
*
* Get the event subscription timeout (in seconds), or 0 meaning there is no
......@@ -909,7 +909,7 @@ host_path_data_free (HostPathData *path_data)
}
/**
* gupnp_context_host_path
* gupnp_context_host_path:
* @context: A #GUPnPContext
* @local_path: Path to the local file or folder to be hosted
* @server_path: Web server path where @local_path should be hosted
......@@ -954,7 +954,7 @@ path_compare_func (HostPathData *path_data,
}
/**
* gupnp_context_host_path_for_agent
* gupnp_context_host_path_for_agent:
* @context: A #GUPnPContext
* @local_path: Path to the local file or folder to be hosted
* @server_path: Web server path already being hosted
......@@ -997,7 +997,7 @@ gupnp_context_host_path_for_agent (GUPnPContext *context,
}
/**
* gupnp_context_unhost_path
* gupnp_context_unhost_path:
* @context: A #GUPnPContext
* @server_path: Web server path where the file or folder is hosted
*
......
......@@ -875,7 +875,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPControlPointPrivate));
/**
* GUPnPControlPoint:resource-factory
* GUPnPControlPoint:resource-factory:
*
* The resource factory to use. Set to NULL for default factory.
**/
......@@ -893,7 +893,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPControlPoint::device-proxy-available
* GUPnPControlPoint::device-proxy-available:
* @control_point: The #GUPnPControlPoint that received the signal
* @proxy: The now available #GUPnPDeviceProxy
*
......@@ -914,7 +914,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
GUPNP_TYPE_DEVICE_PROXY);
/**
* GUPnPControlPoint::device-proxy-unavailable
* GUPnPControlPoint::device-proxy-unavailable:
* @control_point: The #GUPnPControlPoint that received the signal
* @proxy: The now unavailable #GUPnPDeviceProxy
*
......@@ -935,7 +935,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
GUPNP_TYPE_DEVICE_PROXY);
/**
* GUPnPControlPoint::service-proxy-available
* GUPnPControlPoint::service-proxy-available:
* @control_point: The #GUPnPControlPoint that received the signal
* @proxy: The now available #GUPnPServiceProxy
*
......@@ -956,7 +956,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
GUPNP_TYPE_SERVICE_PROXY);
/**
* GUPnPControlPoint::service-proxy-unavailable
* GUPnPControlPoint::service-proxy-unavailable:
* @control_point: The #GUPnPControlPoint that received the signal
* @proxy: The now unavailable #GUPnPServiceProxy
*
......@@ -978,7 +978,7 @@ gupnp_control_point_class_init (GUPnPControlPointClass *klass)
}
/**
* gupnp_control_point_new
* gupnp_control_point_new:
* @context: A #GUPnPContext
* @target: The search target
*
......@@ -1004,7 +1004,7 @@ gupnp_control_point_new (GUPnPContext *context,
}
/**
* gupnp_control_point_new_full
* gupnp_control_point_new_full:
* @context: A #GUPnPContext
* @factory: A #GUPnPResourceFactory
* @target: The search target
......@@ -1036,7 +1036,7 @@ gupnp_control_point_new_full (GUPnPContext *context,
}
/**
* gupnp_control_point_get_context
* gupnp_control_point_get_context:
* @control_point: A #GUPnPControlPoint
*
* Get the #GUPnPControlPoint associated with @control_point.
......@@ -1093,7 +1093,7 @@ gupnp_control_point_list_service_proxies (GUPnPControlPoint *control_point)
}
/**
* gupnp_control_point_get_resource_factory
* gupnp_control_point_get_resource_factory:
* @control_point: A #GUPnPControlPoint
*
* Get the #GUPnPResourceFactory used by the @control_point.
......
......@@ -216,7 +216,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPDeviceInfoPrivate));
/**
* GUPnPDeviceInfo:resource-factory
* GUPnPDeviceInfo:resource-factory:
*
* The resource factory to use. Set to NULL for default factory.
**/
......@@ -234,7 +234,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:context
* GUPnPDeviceInfo:context:
*
* The #GUPnPContext to use.
**/
......@@ -252,7 +252,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:location
* GUPnPDeviceInfo:location:
*
* The location of the device description file.
**/
......@@ -271,7 +271,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:udn
* GUPnPDeviceInfo:udn:
*
* The UDN of this device.
**/
......@@ -289,7 +289,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:device-type
* GUPnPDeviceInfo:device-type:
*
* The device type.
**/
......@@ -307,7 +307,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:url-base
* GUPnPDeviceInfo:url-base:
*
* The URL base (#SoupURI).
**/
......@@ -324,7 +324,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:document
* GUPnPDeviceInfo:document:
*
* Private property.
*
......@@ -345,7 +345,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:element
* GUPnPDeviceInfo:element:
*
* Private property.
*
......@@ -366,7 +366,7 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
}
/**
* gupnp_device_info_get_resource_factory
* gupnp_device_info_get_resource_factory:
* @device_info: A #GUPnPDeviceInfo
*
* Get the #GUPnPResourceFactory used by the @device_info.
......@@ -382,7 +382,7 @@ gupnp_device_info_get_resource_factory (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_context
* gupnp_device_info_get_context:
* @info: A #GUPnPDeviceInfo
*
* Get the associated #GUPnPContext.
......@@ -398,7 +398,7 @@ gupnp_device_info_get_context (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_location
* gupnp_device_info_get_location:
* @info: A #GUPnPDeviceInfo
*
* Get the location of the device description file.
......@@ -414,7 +414,7 @@ gupnp_device_info_get_location (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_url_base
* gupnp_device_info_get_url_base:
* @info: A #GUPnPDeviceInfo
*
* Get the URL base of this device.
......@@ -430,7 +430,7 @@ gupnp_device_info_get_url_base (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_udn
* gupnp_device_info_get_udn:
* @info: A #GUPnPDeviceInfo
*
* Get the Unique Device Name of the device.
......@@ -452,7 +452,7 @@ gupnp_device_info_get_udn (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_device_type
* gupnp_device_info_get_device_type:
* @info: A #GUPnPDeviceInfo
*
* Get the UPnP device type.
......@@ -474,7 +474,7 @@ gupnp_device_info_get_device_type (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_friendly_name
* gupnp_device_info_get_friendly_name:
* @info: A #GUPnPDeviceInfo
*
* Get the friendly name of the device.
......@@ -491,7 +491,7 @@ gupnp_device_info_get_friendly_name (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_manufacturer
* gupnp_device_info_get_manufacturer:
* @info: A #GUPnPDeviceInfo
*
* Get the manufacturer of the device.
......@@ -508,7 +508,7 @@ gupnp_device_info_get_manufacturer (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_manufacturer_url
* gupnp_device_info_get_manufacturer_url:
* @info: A #GUPnPDeviceInfo
*
* Get a URL pointing to the manufacturer's website.
......@@ -526,7 +526,7 @@ gupnp_device_info_get_manufacturer_url (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_model_description
* gupnp_device_info_get_model_description:
* @info: A #GUPnPDeviceInfo
*
* Get the description of the device model.
......@@ -543,7 +543,7 @@ gupnp_device_info_get_model_description (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_model_name
* gupnp_device_info_get_model_name:
* @info: A #GUPnPDeviceInfo
*
* Get the model name of the device.
......@@ -560,7 +560,7 @@ gupnp_device_info_get_model_name (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_model_number
* gupnp_device_info_get_model_number:
* @info: A #GUPnPDeviceInfo
*
* Get the model number of the device.
......@@ -577,7 +577,7 @@ gupnp_device_info_get_model_number (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_model_url
* gupnp_device_info_get_model_url:
* @info: A #GUPnPDeviceInfo
*
* Get a URL pointing to the device model's website.
......@@ -595,7 +595,7 @@ gupnp_device_info_get_model_url (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_serial_number
* gupnp_device_info_get_serial_number:
* @info: A #GUPnPDeviceInfo
*
* Get the serial number of the device.
......@@ -612,7 +612,7 @@ gupnp_device_info_get_serial_number (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_upc
* gupnp_device_info_get_upc:
* @info: A #GUPnPDeviceInfo
*
* Get the Universal Product Code of the device.
......@@ -629,7 +629,7 @@ gupnp_device_info_get_upc (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_presentation_url
* gupnp_device_info_get_presentation_url:
* @info: A #GUPnPDeviceInfo
*
* Get a URL pointing to the device's presentation page, for web-based
......@@ -930,7 +930,7 @@ resource_type_match (const char *query,
}
/**
* gupnp_device_info_list_dlna_capabilities
* gupnp_device_info_list_dlna_capabilities:
* @info: A #GUPnPDeviceInfo
*
* Get a #GList of strings that represent the device capabilities as announced
......@@ -984,7 +984,7 @@ gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_description_value
* gupnp_device_info_get_description_value:
* @info: A #GUPnPDeviceInfo
* @element: Name of the description element to retrieve
*
......@@ -1097,7 +1097,7 @@ gupnp_device_info_list_device_types (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_device
* gupnp_device_info_get_device:
* @info: A #GUPnPDeviceInfo
* @type: The type of the device to be retrieved.
*
......@@ -1251,7 +1251,7 @@ gupnp_device_info_list_service_types (GUPnPDeviceInfo *info)
}
/**
* gupnp_device_info_get_service
* gupnp_device_info_get_service:
* @info: A #GUPnPDeviceInfo
* @type: The type of the service to be retrieved.
*
......
......@@ -226,7 +226,7 @@ gupnp_device_class_init (GUPnPDeviceClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPDevicePrivate));
/**
* GUPnPDevice:root-device
* GUPnPDevice:root-device:
*
* The containing #GUPnPRootDevice, or NULL if this is the root
* device.
......
......@@ -75,7 +75,7 @@ gupnp_resource_factory_class_init (GUPnPResourceFactoryClass *klass)
}
/**
* gupnp_resource_factory_new
* gupnp_resource_factory_new:
*
* Create a new #GUPnPResourceFactory object.
*
......@@ -88,7 +88,7 @@ gupnp_resource_factory_new (void)
}
/**
* gupnp_resource_factory_get_default
* gupnp_resource_factory_get_default:
*
* Get the default singleton #GUPnPResourceFactory object.
*
......@@ -108,7 +108,7 @@ gupnp_resource_factory_get_default (void)
}
/**
* gupnp_resource_factory_create_device_proxy
* gupnp_resource_factory_create_device_proxy:
* @factory: A #GUPnPResourceFactory
* @context: A #GUPnPContext
* @doc: A #GUPnPXMLDoc
......@@ -171,7 +171,7 @@ gupnp_resource_factory_create_device_proxy
}
/**
* gupnp_resource_factory_create_service_proxy
* gupnp_resource_factory_create_service_proxy:
* @factory: A #GUPnPResourceFactory
* @context: A #GUPnPContext
* @doc: A #GUPnPXMLDoc
......@@ -230,7 +230,7 @@ gupnp_resource_factory_create_service_proxy
}
/**
* gupnp_resource_factory_create_device
* gupnp_resource_factory_create_device:
* @factory: A #GUPnPResourceFactory
* @context: A #GUPnPContext
* @root_device: The #GUPnPRootDevice
......@@ -291,7 +291,7 @@ gupnp_resource_factory_create_device
}
/**
* gupnp_resource_factory_create_service
* gupnp_resource_factory_create_service:
* @factory: A #GUPnPResourceFactory
* @context: A #GUPnPContext
* @root_device: The #GUPnPRootDevice
......@@ -352,7 +352,7 @@ gupnp_resource_factory_create_service
}
/**
* gupnp_resource_factory_register_resource_type
* gupnp_resource_factory_register_resource_type:
* @factory: A #GUPnPResourceFactory.
* @upnp_type: The UPnP type name of the resource.
* @type: The requested GType assignment for the resource.
......@@ -375,7 +375,7 @@ gupnp_resource_factory_register_resource_type (GUPnPResourceFactory *factory,
}
/**
* gupnp_resource_factory_unregister_resource_type
* gupnp_resource_factory_unregister_resource_type:
* @factory: A #GUPnPResourceFactory.
* @upnp_type: The UPnP type name of the resource.
*
......@@ -394,7 +394,7 @@ gupnp_resource_factory_unregister_resource_type
}
/**
* gupnp_resource_factory_register_resource_proxy_type
* gupnp_resource_factory_register_resource_proxy_type:
* @factory: A #GUPnPResourceFactory.
* @upnp_type: The UPnP type name of the resource.
* @type: The requested GType assignment for the resource proxy.
......@@ -418,7 +418,7 @@ gupnp_resource_factory_register_resource_proxy_type
}
/**
* gupnp_resource_factory_unregister_resource_proxy_type
* gupnp_resource_factory_unregister_resource_proxy_type:
* @factory: A #GUPnPResourceFactory.
* @upnp_type: The UPnP type name of the resource.
*
......
......@@ -478,7 +478,7 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass)
g_type_class_add_private (klass, sizeof (GUPnPRootDevicePrivate));
/**
* GUPnPRootDevice:description-doc
* GUPnPRootDevice:description-doc:
*
* Device description document. Constructor property.
**/
......@@ -496,7 +496,7 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPRootDevice:description-path
* GUPnPRootDevice:description-path:
*
* The path to device description document. This could either be an
* absolute path or path relative to GUPnPRootDevice:description-dir.
......@@ -515,7 +515,7 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPRootDevice:description-dir
* GUPnPRootDevice:description-dir:
*
* The path to directory where description documents are provided.
**/
......@@ -534,7 +534,7 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass)
G_PARAM_STATIC_BLURB));
/**
* GUPnPRootDevice:available
* GUPnPRootDevice:available:
*
* TRUE if this device is available.
**/
......@@ -580,7 +580,7 @@ gupnp_root_device_new (GUPnPContext *context,
}
/**
* gupnp_root_device_new_full
* gupnp_root_device_new_full:
* @context: A #GUPnPContext
* @factory: A #GUPnPResourceFactory
* @description_doc: Device description document, or %NULL
......@@ -615,7 +615,7 @@ gupnp_root_device_new_full (GUPnPContext *context,
}
/**
* gupnp_root_device_set_available
* gupnp_root_device_set_available:
* @root_device: A #GUPnPRootDevice
* @available: %TRUE if @root_device should be available
*
......@@ -635,7 +635,7 @@ gupnp_root_device_set_available (GUPnPRootDevice *root_device,
}
/**
* gupnp_root_device_get_available
* gupnp_root_device_get_available:
* @root_device: A #GUPnPRootDevice
*
* Get whether or not @root_device is available (announcing its presence).
......@@ -651,7 +651,7 @@ gupnp_root_device_get_available (GUPnPRootDevice *root_device)
}
/**
* gupnp_root_device_get_relative_location