Remove unnecessary gtk-doc comments and move them where possible from libpurple/[d-m]*.h
Testing Done:
Compiled
Reviewed at https://reviews.imfreedom.org/r/1179/
--- a/libpurple/debug.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/debug.h Sun Dec 12 05:08:39 2021 -0600
@@ -27,13 +27,6 @@
- * @section_id: libpurple-debug- * @short_description: Developer Logging API--- a/libpurple/eventloop.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/eventloop.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
#ifndef PURPLE_EVENTLOOP_H
#define PURPLE_EVENTLOOP_H
- * @section_id: libpurple-eventloop- * @short_description: <filename>eventloop.h</filename>- * @title: Event Loop API--- a/libpurple/glibcompat.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/glibcompat.h Sun Dec 12 05:08:39 2021 -0600
@@ -19,17 +19,14 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
+ * This file is internal to libpurple. Do not use! + * Also, any public API should not depend on this file. #ifndef PURPLE_GLIBCOMPAT_H
#define PURPLE_GLIBCOMPAT_H
- * @section_id: libpurple-glibcompat- * @short_description: <filename>glibcompat.h</filename>- * @title: GLib version-dependent definitions- * This file is internal to libpurple. Do not use!- * Also, any public API should not depend on this file.--- a/libpurple/group.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/group.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
- * @section_id: libpurple-group- * @short_description: <filename>group.h</filename>- * @title: Buddy, Chat, Contact and Group node Objects #include "countingnode.h"
--- a/libpurple/idle.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/idle.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
- * @section_id: libpurple-idle- * @short_description: <filename>idle.h</filename>--- a/libpurple/image-store.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/image-store.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,9 @@
#ifndef PURPLE_IMAGE_STORE_H
#define PURPLE_IMAGE_STORE_H
- * @include:image-store.h- * @section_id: libpurple-image-store- * @short_description: a global, temporary storage for images * Image store references #PurpleImage's by a simple integer value.
* It's a convenient way to embed images in HTML-like strings.
--- a/libpurple/image.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/image.h Sun Dec 12 05:08:39 2021 -0600
@@ -26,22 +26,6 @@
- * @section_id: libpurple-image- * @short_description: implementation-independent image data container- * #PurpleImage object is a container for raw image data. It doesn't manipulate- * image data, just stores it in its binary format - png, jpeg etc. Thus, it's- * totally independent from the UI.- * This class also provides certain file-related features, like: friendly- * filenames (not necessarily real filename for displaying); remote images- * (which data is not yet loaded) or guessing file format from its header.@@ -64,6 +48,18 @@
+ * #PurpleImage object is a container for raw image data. It doesn't manipulate + * image data, just stores it in its binary format - png, jpeg etc. Thus, it's + * totally independent from the UI. + * This class also provides certain file-related features, like: friendly + * filenames (not necessarily real filename for displaying); remote images + * (which data is not yet loaded) or guessing file format from its header. * Returns: the #GType for an image.
--- a/libpurple/internal.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/internal.h Sun Dec 12 05:08:39 2021 -0600
@@ -21,12 +21,6 @@
#ifndef PURPLE_INTERNAL_H
#define PURPLE_INTERNAL_H
- * @section_id: libpurple-internal- * @short_description: <filename>internal.h</filename>- * @title: Internal definitions and includes #if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
--- a/libpurple/media-gst.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/media-gst.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
#ifndef PURPLE_MEDIA_GST_H
#define PURPLE_MEDIA_GST_H
- * @section_id: libpurple-media-gst- * @short_description: <filename>media-gst.h</filename>- * @title: Media Element API #include "mediamanager.h"
--- a/libpurple/media.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/media.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
- * @section_id: libpurple-media- * @short_description: <filename>media.h</filename>- * @title: Media Object API--- a/libpurple/mediamanager.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/mediamanager.h Sun Dec 12 05:08:39 2021 -0600
@@ -25,12 +25,6 @@
#ifndef PURPLE_MEDIA_MANAGER_H
#define PURPLE_MEDIA_MANAGER_H
- * @section_id: libpurple-mediamanager- * @short_description: <filename>mediamanager.h</filename>- * @title: Media Manager Object--- a/libpurple/memorypool.h Sun Dec 12 04:08:55 2021 -0600
+++ b/libpurple/memorypool.h Sun Dec 12 05:08:39 2021 -0600
@@ -26,26 +26,6 @@
#ifndef PURPLE_MEMORY_POOL_H
#define PURPLE_MEMORY_POOL_H
- * @include:memorypool.h- * @section_id: libpurple-memorypool- * @short_description: a container for a large number of small chunks of memory- * A #PurpleMemoryPool allows allocating many small objects within a single- * memory range and releasing them all at once using a single call. This- * prevents memory fragmentation and improves performance when used properly.- * It's purpose is to act as an internal storage for other object private- * structures, like tree nodes, string chunks, list elements.- * Current implementation is not optimized for releasing individual objects,- * so it may be extremely inefficient, when misused. On every memory allocation,- * it checks if there is enough space in current block. If there is not enough- * room here, it creates another block of memory. On pool destruction or calling- * #purple_memory_pool_cleanup, the whole block chain will be freed, using only- * one #g_free call for every block.@@ -67,7 +47,18 @@
- * The memory pool object instance.+ * A #PurpleMemoryPool allows allocating many small objects within a single + * memory range and releasing them all at once using a single call. This + * prevents memory fragmentation and improves performance when used properly. + * Its purpose is to act as an internal storage for other object private + * structures, like tree nodes, string chunks, list elements. + * Current implementation is not optimized for releasing individual objects, + * so it may be extremely inefficient, when misused. On every memory allocation, + * it checks if there is enough space in current block. If there is not enough + * room here, it creates another block of memory. On pool destruction or calling + * #purple_memory_pool_cleanup, the whole block chain will be freed, using only + * one #g_free call for every block.
