GNOME.org
 

[gnome-builder] libide-core: cleanup context availability macros

commit 0a9c61b9afbb6bd014288a93afc74459bcedbb75
Author: Christian Hergert <chergert redhat com>
Date:   Mon Jul 11 16:28:32 2022 -0700

    libide-core: cleanup context availability macros

 src/libide/core/ide-build-ident.h.in |  2 --
 src/libide/core/ide-context-addin.c  | 12 -----------
 src/libide/core/ide-context-addin.h  | 14 ++++++-------
 src/libide/core/ide-context.c        | 40 ------------------------------------
 src/libide/core/ide-context.h        | 38 +++++++++++++++++-----------------
 src/libide/core/ide-debug.h.in       | 16 ---------------
 src/libide/core/ide-global.c         |  8 --------
 src/libide/core/ide-global.h         | 22 ++++++++++----------
 8 files changed, 37 insertions(+), 115 deletions(-)
---
diff --git a/src/libide/core/ide-build-ident.h.in b/src/libide/core/ide-build-ident.h.in
index 51f0266b5..d63091574 100644
--- a/src/libide/core/ide-build-ident.h.in
+++ b/src/libide/core/ide-build-ident.h.in
@@ -26,8 +26,6 @@ G_BEGIN_DECLS
  * SECTION:ide-build-ident
  * @title: Build Identifier
  * @short_description: Identify a build by unique build identifier
- *
- * Since: 3.22
  */
 
 /**
diff --git a/src/libide/core/ide-context-addin.c b/src/libide/core/ide-context-addin.c
index 3f3071ffc..88f113f9d 100644
--- a/src/libide/core/ide-context-addin.c
+++ b/src/libide/core/ide-context-addin.c
@@ -70,8 +70,6 @@ ide_context_addin_default_init (IdeContextAddinInterface *iface)
    * being successfully loaded first. Every addin's
    * ide_context_addin_load_project_async() will have been called and completed
    * before this signal is emitted.
-   *
-   * Since: 3.32
    */
   signals [PROJECT_LOADED] =
     g_signal_new ("project-loaded",
@@ -97,8 +95,6 @@ ide_context_addin_default_init (IdeContextAddinInterface *iface)
  * Requests to load a project with the #IdeContextAddin.
  *
  * This function is called when the #IdeContext requests loading a project.
- *
- * Since: 3.32
  */
 void
 ide_context_addin_load_project_async (IdeContextAddin     *self,
@@ -126,8 +122,6 @@ ide_context_addin_load_project_async (IdeContextAddin     *self,
  * ide_context_addin_load_project_async().
  *
  * Returns: %TRUE if successful; otherwise %FALSE and @error is set.
- *
- * Since: 3.32
  */
 gboolean
 ide_context_addin_load_project_finish (IdeContextAddin  *self,
@@ -150,8 +144,6 @@ ide_context_addin_load_project_finish (IdeContextAddin  *self,
  * This is called when the #IdeContext is created. If you would rather wait
  * until a project is loaded, then use #IdeContextAddin::project-loaded to
  * load runtime features.
- *
- * Since: 3.32
  */
 void
 ide_context_addin_load (IdeContextAddin *self,
@@ -171,8 +163,6 @@ ide_context_addin_load (IdeContextAddin *self,
  *
  * Requests that the #IdeContextAddin unloads any previously loaded
  * resources.
- *
- * Since: 3.32
  */
 void
 ide_context_addin_unload (IdeContextAddin *self,
@@ -193,8 +183,6 @@ ide_context_addin_unload (IdeContextAddin *self,
  * Emits the #IdeContextAddin::project-loaded signal.
  *
  * This is called when the context has completed loading a project.
- *
- * Since: 3.32
  */
 void
 ide_context_addin_project_loaded (IdeContextAddin *self,
diff --git a/src/libide/core/ide-context-addin.h b/src/libide/core/ide-context-addin.h
index 74ebab184..77eae91d3 100644
--- a/src/libide/core/ide-context-addin.h
+++ b/src/libide/core/ide-context-addin.h
@@ -27,7 +27,7 @@ G_BEGIN_DECLS
 
 #define IDE_TYPE_CONTEXT_ADDIN (ide_context_addin_get_type())
 
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 G_DECLARE_INTERFACE (IdeContextAddin, ide_context_addin, IDE, CONTEXT_ADDIN, GObject)
 
 struct _IdeContextAddinInterface
@@ -50,26 +50,26 @@ struct _IdeContextAddinInterface
                                    IdeContext           *context);
 };
 
-IDE_AVAILABLE_IN_3_40
+IDE_AVAILABLE_IN_ALL
 IdeContextAddin *ide_context_addin_find_by_module_name (IdeContext  *context,
                                                         const gchar *module_name);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void             ide_context_addin_load_project_async  (IdeContextAddin      *self,
                                                         IdeContext           *context,
                                                         GCancellable         *cancellable,
                                                         GAsyncReadyCallback   callback,
                                                         gpointer              user_data);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gboolean         ide_context_addin_load_project_finish (IdeContextAddin      *self,
                                                         GAsyncResult         *result,
                                                         GError              **error);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void             ide_context_addin_load                (IdeContextAddin      *self,
                                                         IdeContext           *context);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void             ide_context_addin_unload              (IdeContextAddin      *self,
                                                         IdeContext           *context);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void             ide_context_addin_project_loaded      (IdeContextAddin      *self,
                                                         IdeContext           *context);
 
diff --git a/src/libide/core/ide-context.c b/src/libide/core/ide-context.c
index 50c373787..ddfe4d471 100644
--- a/src/libide/core/ide-context.c
+++ b/src/libide/core/ide-context.c
@@ -38,8 +38,6 @@
  *
  * The #IdeContext object is the root object for a project. Everything
  * in a project is contained by this object.
- *
- * Since: 3.32
  */
 
 struct _IdeContext
@@ -290,8 +288,6 @@ ide_context_class_init (IdeContextClass *klass)
    *
    * Before any project has loaded, this is "empty" to allow flexibility
    * for non-project use.
-   *
-   * Since: 3.32
    */
   properties [PROP_PROJECT_ID] =
     g_param_spec_string ("project-id",
@@ -304,8 +300,6 @@ ide_context_class_init (IdeContextClass *klass)
    * IdeContext:title:
    *
    * The "title" property is a descriptive name for the project.
-   *
-   * Since: 3.32
    */
   properties [PROP_TITLE] =
     g_param_spec_string ("title",
@@ -320,8 +314,6 @@ ide_context_class_init (IdeContextClass *klass)
    * The "workdir" property is the best guess at the working directory for the
    * context. This may be discovered using a common parent if multiple files
    * are opened without a project.
-   *
-   * Since: 3.32
    */
   properties [PROP_WORKDIR] =
     g_param_spec_object ("workdir",
@@ -340,8 +332,6 @@ ide_context_class_init (IdeContextClass *klass)
    * @message: the log message
    *
    * This signal is emitted when a log item has been added for the context.
-   *
-   * Since: 3.32
    */
   signals [LOG] =
     g_signal_new_class_handler ("log",
@@ -379,8 +369,6 @@ ide_context_init (IdeContext *self)
  * g_async_initable_init_async().
  *
  * Returns: (transfer full): an #IdeContext
- *
- * Since: 3.32
  */
 IdeContext *
 ide_context_new (void)
@@ -423,8 +411,6 @@ ide_context_peek_child_typed_cb (IdeObject *object,
  *
  * Returns: (transfer none) (type IdeObject) (nullable): an #IdeObject that
  *   matches @type if successful; otherwise %NULL
- *
- * Since: 3.32
  */
 gpointer
 ide_context_peek_child_typed (IdeContext *self,
@@ -452,8 +438,6 @@ ide_context_peek_child_typed (IdeContext *self,
  * Copies the project-id and returns it to the caller.
  *
  * Returns: (transfer full): a project-id as a string
- *
- * Since: 3.32
  */
 gchar *
 ide_context_dup_project_id (IdeContext *self)
@@ -478,8 +462,6 @@ ide_context_dup_project_id (IdeContext *self)
  * Sets the project-id for the context.
  *
  * Generally, this should only be done once after loading a project.
- *
- * Since: 3.32
  */
 void
 ide_context_set_project_id (IdeContext  *self,
@@ -508,8 +490,6 @@ ide_context_set_project_id (IdeContext  *self,
  * reference count by one.
  *
  * Returns: (transfer full): a #GFile
- *
- * Since: 3.32
  */
 GFile *
 ide_context_ref_workdir (IdeContext *self)
@@ -536,8 +516,6 @@ ide_context_ref_workdir (IdeContext *self)
  *
  * In future releases, changes may be made to change this in support of
  * git-worktrees or similar workflows.
- *
- * Since: 3.32
  */
 void
 ide_context_set_workdir (IdeContext *self,
@@ -560,8 +538,6 @@ ide_context_set_workdir (IdeContext *self,
  * Like ide_context_cache_filename() but returns a #GFile.
  *
  * Returns: (transfer full): a #GFile for the cache file
- *
- * Since: 3.32
  */
 GFile *
 ide_context_cache_file (IdeContext  *self,
@@ -617,8 +593,6 @@ ide_context_cache_file (IdeContext  *self,
  * of g_get_user_cache_dir().
  *
  * Returns: (transfer full): A new string containing the cache filename
- *
- * Since: 3.32
  */
 gchar *
 ide_context_cache_filename (IdeContext  *self,
@@ -669,8 +643,6 @@ ide_context_cache_filename (IdeContext  *self,
  * - Otherwise, a #GFile child of #IdeContext:workdir is returned.
  *
  * Returns: (transfer full): a #GFile
- *
- * Since: 3.32
  */
 GFile *
 ide_context_build_file (IdeContext  *self,
@@ -701,8 +673,6 @@ ide_context_build_file (IdeContext  *self,
  * loaded project.
  *
  * Returns: (transfer full): a string containing the new path
- *
- * Since: 3.32
  */
 gchar *
 ide_context_build_filename (IdeContext  *self,
@@ -750,8 +720,6 @@ ide_context_build_filename (IdeContext  *self,
  * This creates a new #GSettings instance for the project.
  *
  * Returns: (transfer full): a #GSettings
- *
- * Since: 3.32
  */
 GSettings *
 ide_context_ref_project_settings (IdeContext *self)
@@ -772,8 +740,6 @@ ide_context_ref_project_settings (IdeContext *self)
  * @self: a #IdeContext
  *
  * Returns: (transfer full): a string containing the title
- *
- * Since: 3.32
  */
 gchar *
 ide_context_dup_title (IdeContext *self)
@@ -797,8 +763,6 @@ ide_context_dup_title (IdeContext *self)
  * Sets the #IdeContext:title property. This is used by various
  * components to show the user the name of the project. This may
  * include the omnibar and the window title.
- *
- * Since: 3.32
  */
 void
 ide_context_set_title (IdeContext  *self,
@@ -837,8 +801,6 @@ ide_context_log (IdeContext     *self,
  * Checks to see if a project has been loaded in @context.
  *
  * Returns: %TRUE if a project has been, or is currently, loading.
- *
- * Since: 3.32
  */
 gboolean
 ide_context_has_project (IdeContext *self)
@@ -872,8 +834,6 @@ _ide_context_set_has_project (IdeContext *self)
  * Finds the addin (if any) matching the plugin's @module_name.
  *
  * Returns: (transfer none) (nullable): an #IdeContextAddin or %NULL
- *
- * Since: 3.40
  */
 IdeContextAddin *
 ide_context_addin_find_by_module_name (IdeContext  *context,
diff --git a/src/libide/core/ide-context.h b/src/libide/core/ide-context.h
index dda1f63d2..40e10bc03 100644
--- a/src/libide/core/ide-context.h
+++ b/src/libide/core/ide-context.h
@@ -30,56 +30,56 @@ G_BEGIN_DECLS
 
 #define IDE_TYPE_CONTEXT (ide_context_get_type())
 
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 G_DECLARE_FINAL_TYPE (IdeContext, ide_context, IDE, CONTEXT, IdeObject)
 
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 IdeContext *ide_context_new                  (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gboolean    ide_context_has_project          (IdeContext     *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gpointer    ide_context_peek_child_typed     (IdeContext     *self,
                                               GType           type);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar      *ide_context_dup_project_id       (IdeContext     *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void        ide_context_set_project_id       (IdeContext     *self,
                                               const gchar    *project_id);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar      *ide_context_dup_title            (IdeContext     *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void        ide_context_set_title            (IdeContext     *self,
                                               const gchar    *title);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 GFile      *ide_context_ref_workdir          (IdeContext     *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void        ide_context_set_workdir          (IdeContext     *self,
                                               GFile          *workdir);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 GFile      *ide_context_build_file           (IdeContext     *self,
                                               const gchar    *path);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar      *ide_context_build_filename       (IdeContext     *self,
                                               const gchar    *first_part,
                                               ...) G_GNUC_NULL_TERMINATED;
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 GFile      *ide_context_cache_file           (IdeContext     *self,
                                               const gchar    *first_part,
                                               ...) G_GNUC_NULL_TERMINATED;
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar      *ide_context_cache_filename       (IdeContext     *self,
                                               const gchar    *first_part,
                                               ...) G_GNUC_NULL_TERMINATED;
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 GSettings  *ide_context_ref_project_settings (IdeContext     *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 IdeContext *ide_object_ref_context           (IdeObject      *self);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 IdeContext *ide_object_get_context           (IdeObject      *object);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void        ide_object_set_context           (IdeObject      *object,
                                               IdeContext     *context);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void        ide_context_log                  (IdeContext     *self,
                                               GLogLevelFlags  level,
                                               const gchar    *domain,
diff --git a/src/libide/core/ide-debug.h.in b/src/libide/core/ide-debug.h.in
index 7d6167b02..95d5067be 100644
--- a/src/libide/core/ide-debug.h.in
+++ b/src/libide/core/ide-debug.h.in
@@ -37,8 +37,6 @@ G_BEGIN_DECLS
  * These tracing macros will compile out when Builder is configured for a
  * release build. Otherwise, running Builder with the "-vvvv" command line
  * argument will show tracing output.
- *
- * Since: 3.18
  */
 
 /**
@@ -46,8 +44,6 @@ G_BEGIN_DECLS
  *
  * Traces the entry into a function. Place this at the beginning of your
  * function above pre-condition checks.
- *
- * Since: 3.18
  */
 
 /**
@@ -55,16 +51,12 @@ G_BEGIN_DECLS
  *
  * Traces the exit from a function. Use this instead of "return" to return
  * and log the function exiting.
- *
- * Since: 3.18
  */
 
 /**
  * IDE_RETURN: (skip)
  *
  * Similar to %IDE_EXIT but allows providing a return value.
- *
- * Since: 3.18
  */
 
 /**
@@ -73,8 +65,6 @@ G_BEGIN_DECLS
  *
  * Appends to the jump to label to the tracing log and then jumps
  * to the label @_l.
- *
- * Since: 3.18
  */
 
 /**
@@ -83,24 +73,18 @@ G_BEGIN_DECLS
  *
  * Appends to the tracing log that unsupported code has been
  * reached.
- *
- * Since: 3.18
  */
 
 /**
  * IDE_PROBE: (skip)
  *
  * Appends to the tracing log that a line of code was reached.
- *
- * Since: 3.18
  */
 
 /**
  * IDE_TRACE_MSG: (skip)
  *
  * Similar to %IDE_PROBE but allows specifying a log message.
- *
- * Since: 3.18
  */
 
 #ifndef IDE_ENABLE_TRACE
diff --git a/src/libide/core/ide-global.c b/src/libide/core/ide-global.c
index 5b2e3db6d..07741aab7 100644
--- a/src/libide/core/ide-global.c
+++ b/src/libide/core/ide-global.c
@@ -68,8 +68,6 @@ ide_init_ctor (void)
  * currently running within.
  *
  * Returns: (transfer none): a #GThread
- *
- * Since: 3.32
  */
 GThread *
 ide_get_main_thread (void)
@@ -83,8 +81,6 @@ ide_get_main_thread (void)
  * Gets the kind of process we're running as.
  *
  * Returns: an #IdeProcessKind
- *
- * Since: 3.32
  */
 IdeProcessKind
 ide_get_process_kind (void)
@@ -108,8 +104,6 @@ ide_get_application_id (void)
  * has connected to the D-Bus.
  *
  * The default is "org.gnome.Builder".
- *
- * Since: 3.32
  */
 void
 ide_set_application_id (const gchar *app_id)
@@ -226,8 +220,6 @@ get_base_path (const gchar *name)
  * Gets the path to a resource that may be relocatable at runtime.
  *
  * Returns: (transfer full): a new string containing the path
- *
- * Since: 3.32
  */
 gchar *
 ide_get_relocatable_path (const gchar *path)
diff --git a/src/libide/core/ide-global.h b/src/libide/core/ide-global.h
index ac3bfabd3..844619d15 100644
--- a/src/libide/core/ide-global.h
+++ b/src/libide/core/ide-global.h
@@ -38,29 +38,29 @@ typedef enum
 
 #define ide_is_flatpak() (ide_get_process_kind() == IDE_PROCESS_KIND_FLATPAK)
 
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 const gchar    *ide_gettext              (const gchar *message);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 GThread        *ide_get_main_thread      (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 IdeProcessKind  ide_get_process_kind     (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 const gchar    *ide_get_application_id   (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 void            ide_set_application_id   (const gchar *app_id);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 const gchar    *ide_get_program_name     (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar          *ide_get_system_arch      (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 const gchar    *ide_get_system_type      (void);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar          *ide_create_host_triplet  (const gchar *arch,
                                           const gchar *kernel,
                                           const gchar *system);
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gsize           ide_get_system_page_size (void) G_GNUC_CONST;
-IDE_AVAILABLE_IN_3_32
+IDE_AVAILABLE_IN_ALL
 gchar          *ide_get_relocatable_path (const gchar *path);
 
 G_END_DECLS
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]