colin/NetworkManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libnm-core: adjust the documentation of proxy setting

Browse Source 
* fix capitalization of abbreviations and normal words
 * use % for Gtk-Doc values
 * and other adjustmens
This commit is contained in:
Jiří Klimeš
2017-01-13 21:39:04 +01:00
committed by Thomas Haller
parent e2c4d4d2c9
commit addac21270
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
libnm-core/nm-setting-proxy.c
View File

@@ -27,15 +27,15 @@
/** /**
* SECTION:nm-setting-proxy * SECTION:nm-setting-proxy
* @short_description: Describes Proxy Url, Script and other related properties * @short_description: Describes proxy URL, script and other related properties
* *
* The #NMSettingProxy object is a #NMSetting subclass that describes properties * The #NMSettingProxy object is a #NMSetting subclass that describes properties
* related to Proxy settings like Pac Url, Pac Script etc. * related to Proxy settings like PAC URL, PAC script etc.
* *
* NetworkManager support 2 values for the #NMSettingProxy:method property for * NetworkManager support 2 values for the #NMSettingProxy:method property for
* proxy. If "auto" is specified then WPAD takes places and the appropriate details * proxy. If "auto" is specified then WPAD takes place and the appropriate details
* are pushed into PacRunner or user can override this URL with a new PAC url or a * are pushed into PacRunner or user can override this URL with a new PAC URL or a
* PAC Script. If "none" is selected then no proxy configuration is given to PacRunner * PAC script. If "none" is selected then no proxy configuration is given to PacRunner
* to fulfill client queries. * to fulfill client queries.
**/ **/
@@ -81,8 +81,8 @@ nm_setting_proxy_new (void)
* nm_setting_proxy_get_method: * nm_setting_proxy_get_method:
* @setting: the #NMSettingProxy * @setting: the #NMSettingProxy
* *
* Returns the proxy configuration method. By default the value is "NONE". * Returns the proxy configuration method. By default the value is %NM_SETTING_PROXY_METHOD_NONE.
* "NONE" should be selected for a connection intended for direct network * %NM_SETTING_PROXY_METHOD_NONE should be selected for a connection intended for direct network
* access. * access.
* *
* Returns: the proxy configuration method * Returns: the proxy configuration method
@@ -101,8 +101,8 @@ nm_setting_proxy_get_method (NMSettingProxy *setting)
* nm_setting_proxy_get_browser_only: * nm_setting_proxy_get_browser_only:
* @setting: the #NMSettingProxy * @setting: the #NMSettingProxy
* *
* Returns: TRUE if this proxy configuration is only for Browser * Returns: %TRUE if this proxy configuration is only for browser
* clients/schemes otherwise FALSE. * clients/schemes, %FALSE otherwise.
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -118,7 +118,7 @@ nm_setting_proxy_get_browser_only (NMSettingProxy *setting)
* nm_setting_proxy_get_pac_url: * nm_setting_proxy_get_pac_url:
* @setting: the #NMSettingProxy * @setting: the #NMSettingProxy
* *
* Returns: the PAC url for obtaining PAC file * Returns: the PAC URL for obtaining PAC file
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -134,7 +134,7 @@ nm_setting_proxy_get_pac_url (NMSettingProxy *setting)
* nm_setting_proxy_get_pac_script: * nm_setting_proxy_get_pac_script:
* @setting: the #NMSettingProxy * @setting: the #NMSettingProxy
* *
* Returns: the PAC Script * Returns: the PAC script
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -301,7 +301,7 @@ nm_setting_proxy_class_init (NMSettingProxyClass *setting_class)
/** /**
* NMSettingProxy:method: * NMSettingProxy:method:
* *
* Method for proxy configuration, Default is "NONE" * Method for proxy configuration, Default is %NM_SETTING_PROXY_METHOD_NONE
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -316,7 +316,7 @@ nm_setting_proxy_class_init (NMSettingProxyClass *setting_class)
/** /**
* NMSettingProxy:browser-only: * NMSettingProxy:browser-only:
* *
* TRUE if Proxy is for Browser Stuff. * Whether the proxy configuration is for browser only.
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -330,7 +330,7 @@ nm_setting_proxy_class_init (NMSettingProxyClass *setting_class)
/** /**
* NMSettingProxy:pac-url: * NMSettingProxy:pac-url:
* *
* PAC Url for obtaining PAC File. * PAC URL for obtaining PAC file.
* *
* Since: 1.6 * Since: 1.6
**/ **/
@@ -344,7 +344,7 @@ nm_setting_proxy_class_init (NMSettingProxyClass *setting_class)
/** /**
* NMSettingProxy:pac-script: * NMSettingProxy:pac-script:
* *
* PAC Script For the connection. * PAC script for the connection.
* *
* Since: 1.6 * Since: 1.6
**/ **/