/soc/2013/ankitkv/gobjectification: 216a37403c5b: Fix a bunch of...
Ankit Vani
a at nevitus.org
Tue Feb 4 07:11:20 EST 2014
Changeset: 216a37403c5beaa033733b8c42b915f1e7c88b69
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-04 17:31 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/216a37403c5b
Description:
Fix a bunch of gtk-doc warnings in pidgin
diffstat:
pidgin/gtk3compat.h | 2 +-
pidgin/gtkblist-theme.h | 11 +++++++----
pidgin/gtkblist.c | 16 ++++++++--------
pidgin/gtkconn.c | 2 +-
pidgin/gtkconv.c | 19 ++++++++++---------
pidgin/gtkdnd-hints.c | 2 +-
pidgin/gtkidle.c | 6 ++++--
pidgin/gtkinternal.h | 2 +-
pidgin/gtkmenutray.h | 2 ++
pidgin/gtkpounce.c | 2 +-
pidgin/gtkprefs.c | 17 +++++++++--------
pidgin/gtksavedstatuses.c | 24 ++++++++++++------------
pidgin/gtkstatusbox.c | 41 +++++++++++++++++++++--------------------
pidgin/gtkstatusbox.h | 1 +
pidgin/gtkutils.c | 11 +++++++----
pidgin/gtkutils.h | 4 ++--
pidgin/gtkwebview.h | 2 +-
pidgin/minidialog.h | 5 ++---
18 files changed, 91 insertions(+), 78 deletions(-)
diffs (truncated from 534 to 300 lines):
diff --git a/pidgin/gtk3compat.h b/pidgin/gtk3compat.h
--- a/pidgin/gtk3compat.h
+++ b/pidgin/gtk3compat.h
@@ -18,7 +18,7 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
-/**
+/*
* SECTION:gtk3compat
* @section_id: pidgin-gtk3compat
* @short_description: <filename>gtk3compat.h</filename>
diff --git a/pidgin/gtkblist-theme.h b/pidgin/gtkblist-theme.h
--- a/pidgin/gtkblist-theme.h
+++ b/pidgin/gtkblist-theme.h
@@ -63,16 +63,19 @@ struct _PidginBlistThemeClass
};
#if 0
-typedef struct
+typedef struct _PidginThemeFont PidginThemeFont;
+struct _PidginThemeFont
{
const gchar *font;
const gchar *color;
-} PidginThemeFont;
+};
#endif
typedef struct _PidginThemeFont PidginThemeFont;
-typedef struct
+typedef struct _PidginBlistLayout PidginBlistLayout;
+
+struct _PidginBlistLayout
{
gint status_icon;
gint text;
@@ -81,7 +84,7 @@ typedef struct
gint buddy_icon;
gboolean show_status;
-} PidginBlistLayout;
+};
G_BEGIN_DECLS
diff --git a/pidgin/gtkblist.c b/pidgin/gtkblist.c
--- a/pidgin/gtkblist.c
+++ b/pidgin/gtkblist.c
@@ -105,13 +105,13 @@ typedef struct
typedef struct
{
- /** Used to hold error minidialogs. Gets packed
- * inside PidginBuddyList.error_buttons
+ /* Used to hold error minidialogs. Gets packed
+ * inside PidginBuddyList.error_buttons
*/
PidginScrollBook *error_scrollbook;
- /** Pointer to the mini-dialog about having signed on elsewhere, if one
- * is showing; @c NULL otherwise.
+ /* Pointer to the mini-dialog about having signed on elsewhere, if one
+ * is showing; %NULL otherwise.
*/
PidginMiniDialog *signed_on_elsewhere;
@@ -120,9 +120,9 @@ typedef struct
guint select_notebook_page_timeout;
#if !GTK_CHECK_VERSION(3,0,0)
- GdkCursor *hand_cursor; /**< Hand cursor */
- GdkCursor *arrow_cursor; /**< Arrow cursor */
- gboolean changing_style; /**< True when changing GTK+ theme style */
+ GdkCursor *hand_cursor; /* Hand cursor */
+ GdkCursor *arrow_cursor; /* Arrow cursor */
+ gboolean changing_style; /* True when changing GTK+ theme style */
#endif
} PidginBuddyListPrivate;
@@ -4616,7 +4616,7 @@ static const char *require_connection[]
static const int require_connection_size = sizeof(require_connection)
/ sizeof(*require_connection);
-/**
+/*
* Rebuild dynamic menus and make menu items sensitive/insensitive
* where appropriate.
*/
diff --git a/pidgin/gtkconn.c b/pidgin/gtkconn.c
--- a/pidgin/gtkconn.c
+++ b/pidgin/gtkconn.c
@@ -44,7 +44,7 @@ typedef struct {
guint timeout;
} PidginAutoRecon;
-/**
+/*
* Contains accounts that are auto-reconnecting.
* The key is a pointer to the PurpleAccount and the
* value is a pointer to a PidginAutoRecon.
diff --git a/pidgin/gtkconv.c b/pidgin/gtkconv.c
--- a/pidgin/gtkconv.c
+++ b/pidgin/gtkconv.c
@@ -71,7 +71,7 @@
#define GTK_TOOLTIPS_VAR gtkconv->tooltips
#include "gtk3compat.h"
-/**
+/*
* A GTK+ Instant Message pane.
*/
struct _PidginImPane
@@ -94,7 +94,7 @@ struct _PidginImPane
guint32 icon_timer;
};
-/**
+/*
* GTK+ Chat panes.
*/
struct _PidginChatPane
@@ -4369,22 +4369,23 @@ add_chat_user_common(PurpleChatConversat
g_free(alias_key);
}
-/**
- * @param most_matched Used internally by this function.
- * @param entered The partial string that the user types before hitting the
+/*
+ * tab_complete_process_item:
+ * @most_matched: Used internally by this function.
+ * @entered: The partial string that the user types before hitting the
* tab key.
- * @param entered_chars The length of entered.
- * @param partial This is a return variable. This will be set to a string
+ * @entered_chars: The length of entered.
+ * @partial: This is a return variable. This will be set to a string
* containing the largest common string between all matches. This will
* be inserted into the input box at the start of the word that the
* user is tab completing. For example, if a chat room contains
* "AlfFan" and "AlfHater" and the user types "a<TAB>" then this will
* contain "Alf"
- * @param matches This is a return variable. If the given name is a potential
+ * @matches: This is a return variable. If the given name is a potential
* match for the entered string, then add a copy of the name to this
* list. The caller is responsible for g_free'ing the data in this
* list.
- * @param name The buddy name or alias or slash command name that we're
+ * @name: The buddy name or alias or slash command name that we're
* checking for a match.
*/
static void
diff --git a/pidgin/gtkdnd-hints.c b/pidgin/gtkdnd-hints.c
--- a/pidgin/gtkdnd-hints.c
+++ b/pidgin/gtkdnd-hints.c
@@ -39,7 +39,7 @@ typedef struct
} HintWindowInfo;
-/**
+/*
* Info about each hint widget. See DndHintWindowId enum.
*/
static HintWindowInfo hint_windows[] = {
diff --git a/pidgin/gtkidle.c b/pidgin/gtkidle.c
--- a/pidgin/gtkidle.c
+++ b/pidgin/gtkidle.c
@@ -42,7 +42,9 @@
#include "idle.h"
-/**
+/*
+ * pidgin_get_time_idle:
+ *
* Get the number of seconds the user has been idle. In Unix-world
* this is based on the X Windows usage. In MS Windows this is
* based on keyboard/mouse usage information obtained from the OS.
@@ -65,7 +67,7 @@
*
* See watch() in xscreensaver/driver/xscreensaver-command.c.
*
- * @return The number of seconds the user has been idle.
+ * Returns: The number of seconds the user has been idle.
*/
#if defined(USE_SCREENSAVER) || defined(HAVE_IOKIT)
static time_t
diff --git a/pidgin/gtkinternal.h b/pidgin/gtkinternal.h
--- a/pidgin/gtkinternal.h
+++ b/pidgin/gtkinternal.h
@@ -18,7 +18,7 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
-/**
+/*
* SECTION:gtkinternal
* @section_id: pidgin-gtkinternal
* @short_description: <filename>gtkinternal.h</filename>
diff --git a/pidgin/gtkmenutray.h b/pidgin/gtkmenutray.h
--- a/pidgin/gtkmenutray.h
+++ b/pidgin/gtkmenutray.h
@@ -46,6 +46,8 @@ typedef struct _PidginMenuTrayClass Pid
*/
struct _PidginMenuTray {
GtkMenuItem gparent;
+
+ /*< public >*/
GtkWidget *tray;
};
diff --git a/pidgin/gtkpounce.c b/pidgin/gtkpounce.c
--- a/pidgin/gtkpounce.c
+++ b/pidgin/gtkpounce.c
@@ -41,7 +41,7 @@
#include <gdk/gdkkeysyms.h>
-/**
+/*
* These are used for the GtkTreeView when you're scrolling through
* all your saved pounces.
*/
diff --git a/pidgin/gtkprefs.c b/pidgin/gtkprefs.c
--- a/pidgin/gtkprefs.c
+++ b/pidgin/gtkprefs.c
@@ -829,18 +829,19 @@ prefs_themes_init(void)
prefs_smiley_themes = gtk_list_store_new(3, GDK_TYPE_PIXBUF, G_TYPE_STRING, G_TYPE_STRING);
}
-/**
+/*
+ * prefs_theme_find_theme:
+ * @path: A directory containing a theme. The theme could be at the
+ * top level of this directory or in any subdirectory thereof.
+ * @type: The type of theme to load. The loader for this theme type
+ * will be used and this loader will determine what constitutes a
+ * "theme."
+ *
* Attempt to load the given directory as a theme. If we are unable to
* open the path as a theme then we recurse into path and attempt to
* load each subdirectory that we encounter.
*
- * @param path A directory containing a theme. The theme could be at the
- * top level of this directory or in any subdirectory thereof.
- * @param type The type of theme to load. The loader for this theme type
- * will be used and this loader will determine what constitutes a
- * "theme."
- *
- * @return A new reference to a PurpleTheme.
+ * Returns: A new reference to a #PurpleTheme.
*/
static PurpleTheme *
prefs_theme_find_theme(const gchar *path, const gchar *type)
diff --git a/pidgin/gtksavedstatuses.c b/pidgin/gtksavedstatuses.c
--- a/pidgin/gtksavedstatuses.c
+++ b/pidgin/gtksavedstatuses.c
@@ -43,7 +43,7 @@
* may be open.
*/
-/**
+/*
* These are used for the GtkTreeView when you're scrolling through
* all your saved statuses.
*/
@@ -58,21 +58,21 @@ enum
STATUS_WINDOW_NUM_COLUMNS
};
-/**
+/*
* These are used for the GtkTreeView containing the list of accounts
* at the bottom of the window when you're editing a particular
* saved status.
*/
enum
{
- /** A hidden column containing a pointer to the PurpleAccount. */
+ /* A hidden column containing a pointer to the PurpleAccount. */
STATUS_EDITOR_COLUMN_ACCOUNT,
- /** A hidden column containing a pointer to the editor for this substatus. */
+ /* A hidden column containing a pointer to the editor for this substatus. */
STATUS_EDITOR_COLUMN_WINDOW,
STATUS_EDITOR_COLUMN_ENABLE_SUBSTATUS,
STATUS_EDITOR_COLUMN_ICON,
STATUS_EDITOR_COLUMN_USERNAME,
- /** A hidden column containing the ID of this PurpleStatusType. */
+ /* A hidden column containing the ID of this PurpleStatusType. */
STATUS_EDITOR_COLUMN_STATUS_ID,
STATUS_EDITOR_COLUMN_STATUS_NAME,
STATUS_EDITOR_COLUMN_STATUS_MESSAGE,
@@ -80,7 +80,7 @@ enum
STATUS_EDITOR_NUM_COLUMNS
};
-/**
+/*
More information about the Commits
mailing list