[gnome-builder] code-indexer: fix G-I annotations
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] code-indexer: fix G-I annotations
- Date: Sat, 11 Nov 2017 01:05:46 +0000 (UTC)
commit d2da9ca9b084b6e1387c4aea8649e39868c0d3c6
Author: Christian Hergert <chergert redhat com>
Date: Fri Nov 10 17:05:29 2017 -0800
code-indexer: fix G-I annotations
src/libide/symbols/ide-code-indexer.c | 15 +++++++++------
1 files changed, 9 insertions(+), 6 deletions(-)
---
diff --git a/src/libide/symbols/ide-code-indexer.c b/src/libide/symbols/ide-code-indexer.c
index a484577..03b50a5 100644
--- a/src/libide/symbols/ide-code-indexer.c
+++ b/src/libide/symbols/ide-code-indexer.c
@@ -75,15 +75,15 @@ ide_code_indexer_default_init (IdeCodeIndexerInterface *iface)
/**
* ide_code_indexer_index_file:
* @self: An #IdeCodeIndexer instance.
- * @file: Source file to index.
- * @build_flags: (nullable): array of build flags to parse @file.
+ * @file: (not nullable): Source file to index.
+ * @build_flags: (out) (optional): array of build flags to parse @file.
* @cancellable: (nullable): a #GCancellable.
* @error: a #GError.
*
* This function will take index source file and create an array
* of symbols in @file.
*
- * Returns: (transfer full) : an #IdeCodeIndexEntries contains list
+ * Returns: (transfer full): an #IdeCodeIndexEntries contains list
* of #IdeCodeIndexEntry.
*
* Since: 3.26
@@ -109,14 +109,14 @@ ide_code_indexer_index_file (IdeCodeIndexer *self,
/**
* ide_code_indexer_generate_key_async:
* @self: An #IdeCodeIndexer instance.
- * @location: Source location of refernece.
+ * @location: (not nullable): Source location of refernece.
* @cancellable: (nullable): a #GCancellable.
* @callback: A callback to execute upon indexing.
* @user_data: User data to pass to @callback.
*
* This function will get key of reference located at #IdeSoureLocation.
*
- * since : 3.26
+ * Since: 3.26
*/
void
ide_code_indexer_generate_key_async (IdeCodeIndexer *self,
@@ -138,12 +138,15 @@ ide_code_indexer_generate_key_async (IdeCodeIndexer *self,
/**
* ide_code_indexer_generate_key_finish:
+ * @self: an #IdeCodeIndexer
+ * @result: a #GAsyncResult
+ * @error: a location for a #GError, or %NULL
*
* Returns key for declaration of reference at a location.
*
* Returns: (transfer full) : A string which contains key.
*
- * since 3.26
+ * Since: 3.26
*/
gchar *
ide_code_indexer_generate_key_finish (IdeCodeIndexer *self,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]