Remove unncessary doc comments in gplugin
gi-docgen doesn't request the section comments nor the comment for the GPLUGIN_TYPE_ macros.
Testing Done:
Built the docs and verified the section removals had no effect. Also verified that GTK4 no long has them.
Reviewed at https://reviews.imfreedom.org/r/1014/
--- a/gplugin/gplugin-core.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-core.c Sun Oct 10 04:13:19 2021 -0500
@@ -24,14 +24,6 @@
#include <gplugin/gplugin-private.h>
- * @short_description: the core API
- * This section contains the core API of GPlugin.
* @GPLUGIN_CORE_FLAGS_NONE: No flags.
* @GPLUGIN_CORE_FLAGS_DISABLE_NATIVE_LOADER: Disable the native plugin loader.
--- a/gplugin/gplugin-loader.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-loader.c Sun Oct 10 04:13:19 2021 -0500
@@ -19,20 +19,6 @@
#include <gplugin/gplugin-loader.h>
- * SECTION:gplugin-loader
- * @title: Plugin Loader
- * @short_description: Abstract class for loading plugins
- * GPluginLoader defines the base behavior for loaders of all languages.
- * The standard _get_type macro for #GPluginLoader.
* An abstract class that should not be accessed directly.
--- a/gplugin/gplugin-manager.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-manager.c Sun Oct 10 04:13:19 2021 -0500
@@ -28,15 +28,6 @@
#include <gplugin/gplugin-private.h>
- * SECTION:gplugin-manager
- * @Short_description: API for managing plugins
- * The manager is used to manager all plugins in GPlugin. This includes
- * loading, unloading, querying, checking for new plugins, and so on.
* GPluginManagerForeachFunc:
* @id: The id of the plugin.
* @plugins: (transfer none) (element-type GPlugin.Plugin): A [class@GLib.SList]
@@ -47,6 +38,16 @@
+ * The manager is responsible for querying plugins as well as telling loaders + * when to load and unload plugins. It also keeps track of paths that should be + * searched for plugins. * @loading_plugin: Signal emitted before a plugin is loaded.
* @loaded_plugin: Signal emitted after a plugin is loaded.
--- a/gplugin/gplugin-native-loader.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-native-loader.c Sun Oct 10 04:13:19 2021 -0500
@@ -23,25 +23,11 @@
#include <gplugin/gplugin-native-plugin.h>
#include <gplugin/gplugin-private.h>
- * SECTION:gplugin-native-loader
- * @title: Native Plugin Loader API
- * @short_description: the native plugin loader API
- * This section contains the native plugin loader API of GPlugin.
#define GPLUGIN_QUERY_SYMBOL "gplugin_query"
#define GPLUGIN_LOAD_SYMBOL "gplugin_load"
#define GPLUGIN_UNLOAD_SYMBOL "gplugin_unload"
- * GPLUGIN_TYPE_NATIVE_LOADER:
- * The standard _get_type macro for #GPluginNativeLoader.
* A #GPluginLoader subclass that is able to load native plugins.
--- a/gplugin/gplugin-native-plugin.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-native-plugin.c Sun Oct 10 04:13:19 2021 -0500
@@ -23,20 +23,6 @@
#include <gplugin/gplugin-native-plugin.h>
- * SECTION:gplugin-native-plugin
- * @title: Native Plugin API
- * @short_description: the native plugin API
- * This section contains the native plugin API of GPlugin.
- * GPLUGIN_TYPE_NATIVE_PLUGIN:
- * The standard _get_type macro for #GPluginNativePlugin.
* An instance of a loaded native plugin. A native plugin is a plugin that was
--- a/gplugin/gplugin-options.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-options.c Sun Oct 10 04:13:19 2021 -0500
@@ -23,16 +23,6 @@
#include <gplugin/gplugin-manager.h>
#include <gplugin/gplugin-options.h>
- * SECTION:gplugin-options
- * @Title: Command line option support
- * @Short_description: command line option support
- * This section contains #gplugin_get_option_group that makes it easy to
- * initialize GPlugin from your application when it is added to a
/******************************************************************************
*****************************************************************************/
--- a/gplugin/gplugin-plugin-info.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-plugin-info.c Sun Oct 10 04:13:19 2021 -0500
@@ -21,20 +21,6 @@
#include <gplugin/gplugin-private.h>
- * SECTION:gplugin-plugin-info
- * @Title: Plugin Info Objects
- * @Short_description: information about plugins.
- * #GPluginPluginInfo holds metadata for plugins.
- * GPLUGIN_TYPE_PLUGIN_INFO:
- * The standard _get_type macro for #GPluginPluginInfo.
* #GPluginPluginInfo holds all of the data about a plugin. It is created when
--- a/gplugin/gplugin-plugin.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-plugin.c Sun Oct 10 04:13:19 2021 -0500
@@ -22,16 +22,6 @@
#include <gplugin/gplugin-private.h>
- * SECTION:gplugin-plugin
- * @Title: Plugin Interface
- * @Short_description: The plugin interface that all plugins must implement.
- * #GPluginPlugin is an interface that defines the behavior of plugins. It
- * is implemented by each loader which add additional data for their
* @GPLUGIN_PLUGIN_STATE_UNKNOWN: The state of the plugin is unknown.
* @GPLUGIN_PLUGIN_STATE_ERROR: There was an error loading or unloading the
@@ -46,15 +36,10 @@
- * The standard _get_type macro for #GPluginPlugin.
- * #GPluginPlugin is an opaque data structure and should not be used directly.
+ * #GPluginPlugin is an interface that represents what GPlugin expects for a --- a/gplugin/gplugin-version.c Sat Oct 09 23:05:38 2021 -0500
+++ b/gplugin/gplugin-version.c Sun Oct 10 04:13:19 2021 -0500
@@ -15,16 +15,6 @@
* License along with this library; if not, see <https://www.gnu.org/licenses/>.
- * SECTION:gplugin-version
- * @Title: Version Information
- * @Short_description: variables and functions to check the version of GPlugin.
- * GPlugin provided version information, primarily useful when building against
- * GPlugin. Applications will not typically use the features described here
- * unless checking for new versions during builds.
#include <glib/gi18n-lib.h>