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/
/* pidgin
*
* Pidgin 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(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif
#ifndef PIDGIN_CORE_H
#define PIDGIN_CORE_H
#include
<glib.h>
#include
<purple.h>
#ifdef _WIN32
#
include
"win32/gtkwin32dep.h"
#endif
/* change this only when we have a sane upgrade path for old prefs */
#define PIDGIN_PREFS_ROOT "/pidgin"
/* Translators may want to transliterate the name.
It is not to be translated. */
#define PIDGIN_NAME _("Pidgin")
/**
* PIDGIN_ALERT_TITLE:
*
* The title that should be used for alert dialogs.
*/
#ifndef _WIN32
# define PIDGIN_ALERT_TITLE ""
#else
# define PIDGIN_ALERT_TITLE PIDGIN_NAME
#endif
/**
* pidgin_start:
* @argc: The argc from main() (or 0 if argv is %NULL).
* @argv: The argv from main(), or %NULL.
*
* Start pidgin with the given command line arguments.
*/
int
pidgin_start
(
int
argc
,
char
*
argv
[]);
/**
* pidgin_core_get_ui_ops:
*
* Gets the #PurpleCoreUiOps that Pidgin sets up. You probably don't want to
* call this.
*
* Returns: The #PurpleCoreUiOps for Pidgin.
*
* Since: 3.0.0
*/
PurpleCoreUiOps
*
pidgin_core_get_ui_ops
(
void
);
#endif
/* PIDGIN_CORE_H */