diff options
| author | Gary Kramlich <grim@reaperworld.com> | 2020-11-05 20:40:01 -0600 |
|---|---|---|
| committer | Gary Kramlich <grim@reaperworld.com> | 2020-11-05 20:40:01 -0600 |
| commit | 852b8104cc14daff78460e0c77ceff48a5311d9c (patch) | |
| tree | 7c7da843aebb4d3b4bf538f264b5be6fed411f82 /libpurple/xfer.h | |
| parent | 6e55c06323517bcc646f94966ac944d656be7a1b (diff) | |
| download | pidgin-852b8104cc14daff78460e0c77ceff48a5311d9c.tar.gz | |
A bunch of documentation cleanups
Testing Done:
Build the docs, verified via libpurple-undocumented.txt
Reviewed at https://reviews.imfreedom.org/r/195/
Diffstat (limited to 'libpurple/xfer.h')
| -rw-r--r-- | libpurple/xfer.h | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/libpurple/xfer.h b/libpurple/xfer.h index 0cc6d72616..692763999c 100644 --- a/libpurple/xfer.h +++ b/libpurple/xfer.h @@ -1,4 +1,6 @@ -/* purple +/* + * Purple - Internet Messaging Library + * Copyright (C) Pidgin Developers <devel@pidgin.im> * * 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 @@ -15,8 +17,7 @@ * 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 + * along with this program; if not, see <https://www.gnu.org/licenses/>. */ #if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION) @@ -31,6 +32,8 @@ * @short_description: <filename>xfer.h</filename> * @title: File Transfer API * @see_also: <link linkend="chapter-signals-xfer">File Transfer signals</link> + * + * The Xfer API is used to manage file transfers. */ /** @@ -99,6 +102,14 @@ G_BEGIN_DECLS * The standard _get_type macro for #PurpleXfer. */ #define PURPLE_TYPE_XFER (purple_xfer_get_type()) + +/** + * purple_xfer_get_type: + * + * The standard _get_type function for #PurpleXfer. + * + * Returns: The #GType for #PurpleXfer. + */ G_DECLARE_DERIVABLE_TYPE(PurpleXfer, purple_xfer, PURPLE, XFER, GObject) /** @@ -748,6 +759,8 @@ void purple_xfer_prepare_thumbnail(PurpleXfer *xfer, const gchar *formats); /** * purple_xfer_ui_ops_get_type: * + * The standard _get_type function for #GType's. + * * Returns: The #GType for the #PurpleXferUiOps boxed structure. */ GType purple_xfer_ui_ops_get_type(void); @@ -816,6 +829,8 @@ PurpleXferUiOps *purple_xfers_get_ui_ops(void); /** * purple_protocol_xfer_get_type: * + * The standard _get_type function for #GType's. + * * Returns: The #GType for the protocol xfer interface. */ G_DECLARE_INTERFACE(PurpleProtocolXfer, purple_protocol_xfer, PURPLE, |