[gnome-builder/wip/gtk4-port: 1616/1774] libide/foundry: add some docs




commit 1fbc9c8fcb2bc9dee5716c9116d5f808d5b27095
Author: Christian Hergert <chergert redhat com>
Date:   Wed Jun 22 17:52:38 2022 -0700

    libide/foundry: add some docs

 src/libide/foundry/ide-pipeline.c | 13 +++++++++++++
 1 file changed, 13 insertions(+)
---
diff --git a/src/libide/foundry/ide-pipeline.c b/src/libide/foundry/ide-pipeline.c
index da05072fe..c0cd3beba 100644
--- a/src/libide/foundry/ide-pipeline.c
+++ b/src/libide/foundry/ide-pipeline.c
@@ -4352,6 +4352,19 @@ ide_pipeline_addin_find_by_module_name (IdePipeline *pipeline,
   return IDE_PIPELINE_ADDIN (ret);
 }
 
+/**
+ * ide_pipeline_prepare_run_context:
+ * @self: a #IdePipeline
+ * @run_context: an #IdeRunContext
+ *
+ * Prepares #IdeRunContext to build within the pipeline.
+ *
+ * You should use this to prepare a new #IdeRunContext to run within the
+ * build pipeline environment before adding arguments and other settings
+ * to the context.
+ *
+ * The runtime will be consulted to modify any commands necessary.
+ */
 void
 ide_pipeline_prepare_run_context (IdePipeline   *self,
                                   IdeRunContext *run_context)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]