Remove unnecessary gtk-doc comments and move them where possible from libpurple/[m-p]*.h

Sat, 11 Dec 2021 20:19:29 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Sat, 11 Dec 2021 20:19:29 -0600
changeset 41201
0df058800827
parent 41200
92a47aa620cf
child 41202
5c41b36cb13e

Remove unnecessary gtk-doc comments and move them where possible from libpurple/[m-p]*.h

Testing Done:
Compiled

Reviewed at https://reviews.imfreedom.org/r/1180/

libpurple/media/backend-fs2.h file | annotate | diff | comparison | revisions
libpurple/media/backend-iface.h file | annotate | diff | comparison | revisions
libpurple/media/candidate.h file | annotate | diff | comparison | revisions
libpurple/media/codec.h file | annotate | diff | comparison | revisions
libpurple/media/enum-types.h file | annotate | diff | comparison | revisions
libpurple/nat-pmp.h file | annotate | diff | comparison | revisions
libpurple/network.h file | annotate | diff | comparison | revisions
libpurple/notify.h file | annotate | diff | comparison | revisions
libpurple/pluginpref.h file | annotate | diff | comparison | revisions
libpurple/plugins.h file | annotate | diff | comparison | revisions
libpurple/prefs.h file | annotate | diff | comparison | revisions
libpurple/protocols.h file | annotate | diff | comparison | revisions
libpurple/proxy.h file | annotate | diff | comparison | revisions
libpurple/purple-gio.h file | annotate | diff | comparison | revisions
--- a/libpurple/media/backend-fs2.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/media/backend-fs2.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,15 +25,6 @@
 
 #ifndef PURPLE_MEDIA_BACKEND_FS2_H
 #define PURPLE_MEDIA_BACKEND_FS2_H
-/*
- * SECTION:backend-fs2
- * @section_id: libpurple-backend-fs2
- * @short_description: <filename>media/backend-fs2.h</filename>
- * @title: Farstream backend for media API
- *
- * This file should not yet be part of libpurple's API.
- * It should remain internal only for now.
- */
 
 #include <glib-object.h>
 
--- a/libpurple/media/backend-iface.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/media/backend-iface.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_MEDIA_BACKEND_IFACE_H
 #define PURPLE_MEDIA_BACKEND_IFACE_H
-/**
- * SECTION:backend-iface
- * @section_id: libpurple-backend-iface
- * @short_description: <filename>media/backend-iface.h</filename>
- * @title: Interface for Media Backends
- */
 
 #include "codec.h"
 #include "enum-types.h"
--- a/libpurple/media/candidate.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/media/candidate.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_MEDIA_CANDIDATE_H
 #define PURPLE_MEDIA_CANDIDATE_H
-/**
- * SECTION:candidate
- * @section_id: libpurple-candidate
- * @short_description: <filename>media/candidate.h</filename>
- * @title: Candidate for Media API
- */
 
 #include "enum-types.h"
 
--- a/libpurple/media/codec.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/media/codec.h	Sat Dec 11 20:19:29 2021 -0600
@@ -26,13 +26,6 @@
 #ifndef PURPLE_MEDIA_CODEC_H
 #define PURPLE_MEDIA_CODEC_H
 
-/**
- * SECTION:codec
- * @section_id: libpurple-codec
- * @short_description: <filename>media/codec.h</filename>
- * @title: Codec for Media API
- */
-
 #include "enum-types.h"
 
 /**
--- a/libpurple/media/enum-types.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/media/enum-types.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_MEDIA_ENUM_TYPES_H
 #define PURPLE_MEDIA_ENUM_TYPES_H
-/**
- * SECTION:enum-types
- * @section_id: libpurple-enum-types
- * @short_description: <filename>media/enum-types.h</filename>
- * @title: Enum types for Media API
- */
 
 #include <glib-object.h>
 
--- a/libpurple/nat-pmp.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/nat-pmp.h	Sat Dec 11 20:19:29 2021 -0600
@@ -30,12 +30,6 @@
 
 #ifndef PURPLE_NAT_PMP_H
 #define PURPLE_NAT_PMP_H
-/**
- * SECTION:nat-pmp
- * @section_id: libpurple-nat-pmp
- * @short_description: <filename>nat-pmp.h</filename>
- * @title: NAT-PMP Implementation
- */
 
 #include <glib.h>
 
--- a/libpurple/network.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/network.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_NETWORK_H
 #define PURPLE_NETWORK_H
-/**
- * SECTION:network
- * @section_id: libpurple-network
- * @short_description: <filename>network.h</filename>
- * @title: Network API
- */
 
 #include <glib.h>
 #include <gio/gio.h>
--- a/libpurple/notify.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/notify.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,13 +25,6 @@
 
 #ifndef PURPLE_NOTIFY_H
 #define PURPLE_NOTIFY_H
-/**
- * SECTION:notify
- * @section_id: libpurple-notify
- * @short_description: <filename>notify.h</filename>
- * @title: Notification API
- * @see_also: <link linkend="chapter-signals-notify">Notify signals</link>
- */
 
 #include <stdlib.h>
 #include <glib-object.h>
--- a/libpurple/pluginpref.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/pluginpref.h	Sat Dec 11 20:19:29 2021 -0600
@@ -26,12 +26,6 @@
 
 #ifndef PURPLE_PLUGINPREF_H
 #define PURPLE_PLUGINPREF_H
-/**
- * SECTION:pluginpref
- * @section_id: libpurple-pluginpref
- * @short_description: <filename>pluginpref.h</filename>
- * @title: Plugin Preferences Frontend
- */
 
 typedef struct _PurplePluginPrefFrame		PurplePluginPrefFrame;
 typedef struct _PurplePluginPref		PurplePluginPref;
--- a/libpurple/plugins.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/plugins.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,15 +25,6 @@
 
 #ifndef PURPLE_PLUGINS_H
 #define PURPLE_PLUGINS_H
-/**
- * SECTION:plugins
- * @section_id: libpurple-plugins
- * @short_description: <filename>plugins.h</filename>
- * @title: Plugin API
- * @see_also: <link linkend="chapter-signals-plugin">Plugin signals</link>,
- *     <link linkend="chapter-plugin-ids">Plugin IDs</link>,
- *     <link linkend="chapter-plugin-i18n">Third Party Plugin Translation</link>
- */
 
 #include <gplugin.h>
 #include <gplugin-native.h>
--- a/libpurple/prefs.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/prefs.h	Sat Dec 11 20:19:29 2021 -0600
@@ -26,12 +26,6 @@
 
 #ifndef PURPLE_PREFS_H
 #define PURPLE_PREFS_H
-/**
- * SECTION:prefs
- * @section_id: libpurple-prefs
- * @short_description: <filename>prefs.h</filename>
- * @title: Preferences API
- */
 
 #include <glib.h>
 
--- a/libpurple/protocols.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/protocols.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_PROTOCOLS_H
 #define PURPLE_PROTOCOLS_H
-/**
- * SECTION:protocols
- * @section_id: libpurple-protocols
- * @short_description: <filename>protocols.h</filename>
- * @title: Protocols Subsystem API
- */
 
 /**************************************************************************/
 /* Basic Protocol Information                                             */
--- a/libpurple/proxy.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/proxy.h	Sat Dec 11 20:19:29 2021 -0600
@@ -25,12 +25,6 @@
 
 #ifndef PURPLE_PROXY_H
 #define PURPLE_PROXY_H
-/**
- * SECTION:proxy
- * @section_id: libpurple-proxy
- * @short_description: <filename>proxy.h</filename>
- * @title: Proxy API
- */
 
 #include <glib.h>
 #include <gio/gio.h>
--- a/libpurple/purple-gio.h	Sat Dec 11 20:18:06 2021 -0600
+++ b/libpurple/purple-gio.h	Sat Dec 11 20:19:29 2021 -0600
@@ -27,11 +27,9 @@
 
 #ifndef PURPLE_GIO_H
 #define PURPLE_GIO_H
+
 /**
- * SECTION:purple-gio
- * @section_id: libpurple-purple-gio
- * @short_description: Gio helper functions
- * @title: Purple Gio API
+ * purple_gio:
  *
  * The Purple Gio API provides helper functions for Gio operations which
  * are commonly used within libpurple and its consumers. These contain

mercurial