pidgin/pidgin
Clone
Summary
Browse
Changes
Graph
Fix various small documentation errors
19 months ago, Elliott Sales de Andrade
316c1207f787
Fix various small documentation errors
Fix missing transfer annotations, remove old syntax from gtk-doc, correct an `element-type` annotation, and fix a typo.
Testing Done:
Compiled with docs on, and got fewer warnings. Also functions with added transfer annotations are no longer unavailable to bindings.
Reviewed at https://reviews.imfreedom.org/r/1855/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_PROXY_H
#define PURPLE_PROXY_H
#include
<glib.h>
#include
<gio/gio.h>
#include
"eventloop.h"
#include
"account.h"
#include
"purpleproxyinfo.h"
G_BEGIN_DECLS
/**************************************************************************/
/* Global Proxy API */
/**************************************************************************/
/**
* purple_global_proxy_get_info:
*
* Returns purple's global proxy information.
*
* Returns: (transfer none): The global proxy information.
*/
PurpleProxyInfo
*
purple_global_proxy_get_info
(
void
);
/**
* purple_global_proxy_set_info:
* @info: The proxy information.
*
* Set purple's global proxy information.
*/
void
purple_global_proxy_set_info
(
PurpleProxyInfo
*
info
);
/**************************************************************************/
/* Proxy API */
/**************************************************************************/
/**
* purple_proxy_get_handle:
*
* Returns the proxy subsystem handle.
*
* Returns: The proxy subsystem handle.
*/
void
*
purple_proxy_get_handle
(
void
);
/**
* purple_proxy_init:
*
* Initializes the proxy subsystem.
*/
void
purple_proxy_init
(
void
);
/**
* purple_proxy_uninit:
*
* Uninitializes the proxy subsystem.
*/
void
purple_proxy_uninit
(
void
);
/**
* purple_proxy_get_setup:
* @account: The account for which the configuration is needed.
*
* Returns configuration of a proxy.
*
* Returns: (transfer none): The configuration of a proxy.
*/
PurpleProxyInfo
*
purple_proxy_get_setup
(
PurpleAccount
*
account
);
/**
* purple_proxy_get_proxy_resolver:
* @account: The account for which to get the proxy resolver.
* @error: Return location for a GError, or NULL.
*
* Returns a #GProxyResolver capable of resolving which proxy
* to use for this account, if any. This object can be given to a
* #GSocketClient for automatic proxy handling or can be used
* directly if desired.
*
* Returns: (transfer full): NULL if there was an error with the
* account's (or system) proxy settings, or a reference to
* a #GProxyResolver on success.
*/
GProxyResolver
*
purple_proxy_get_proxy_resolver
(
PurpleAccount
*
account
,
GError
**
error
);
G_END_DECLS
#endif
/* PURPLE_PROXY_H */