Commit 3987d36e authored by Christian Hergert's avatar Christian Hergert
Browse files

doc: prefer "an" over "A" when #Ide is used

parent 61e17e8b
......@@ -627,7 +627,7 @@ ide_application_get_worker_cb (GObject *object,
/**
* ide_application_get_worker_async:
* @self: A #IdeApplication
* @self: an #IdeApplication
* @plugin_name: The name of the plugin.
* @cancellable: (allow-none): A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback or %NULL.
......@@ -673,7 +673,7 @@ ide_application_get_worker_async (IdeApplication *self,
/**
* ide_application_get_worker_finish:
* @self: A #IdeApplication.
* @self: an #IdeApplication.
* @result: A #GAsyncResult
* @error: a location for a #GError, or %NULL.
*
......@@ -782,7 +782,7 @@ ide_application_get_keybindings_mode (IdeApplication *self)
/**
* ide_application_get_started_at:
* @self: A #IdeApplication.
* @self: an #IdeApplication.
*
* Gets the startup time of the application.
*
......
......@@ -1759,7 +1759,7 @@ ide_buffer_manager_get_buffers (IdeBufferManager *self)
/**
* ide_buffer_manager_get_word_completion:
* @self: A #IdeBufferManager.
* @self: an #IdeBufferManager.
*
* Gets the #GtkSourceCompletionWords completion provider that will complete
* words using the loaded documents.
......
......@@ -204,7 +204,7 @@ ide_buffer_delay_settling (IdeBuffer *self)
/**
* ide_buffer_get_has_diagnostics:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:has-diagnostics property.
* Return whether the buffer contains diagnostic messages or not.
......@@ -224,7 +224,7 @@ ide_buffer_get_has_diagnostics (IdeBuffer *self)
/**
* ide_buffer_get_busy:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:busy property.
* Return whether the buffer is performing background work or not.
......@@ -1820,7 +1820,7 @@ ide_buffer_update_title (IdeBuffer *self)
/**
* ide_buffer_get_file:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the underlying file behind the buffer.
*
......@@ -1838,7 +1838,7 @@ ide_buffer_get_file (IdeBuffer *self)
/**
* ide_buffer_set_file:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @file: An #IdeFile.
*
* Sets the underlying file to use when saving and loading @self to and from storage.
......@@ -1874,7 +1874,7 @@ ide_buffer_set_file (IdeBuffer *self,
/**
* ide_buffer_get_context:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:context property. This is the #IdeContext that owns the buffer.
*
......@@ -1892,7 +1892,7 @@ ide_buffer_get_context (IdeBuffer *self)
/**
* ide_buffer_get_line_flags:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @line: a buffer line number.
*
* Return the flags set for the #IdeBuffer @line number.
......@@ -1965,7 +1965,7 @@ ide_buffer_get_line_flags (IdeBuffer *self,
/**
* ide_buffer_get_highlight_diagnostics:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:highlight-diagnostics property.
* Return whether the diagnostic warnings and errors should be highlighted.
......@@ -1984,7 +1984,7 @@ ide_buffer_get_highlight_diagnostics (IdeBuffer *self)
/**
* ide_buffer_set_highlight_diagnostics:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @highlight_diagnostics: Whether to highlight the diagnostics or not.
*
* Sets the #IdeBuffer:highlight-diagnostics property.
......@@ -2010,7 +2010,7 @@ ide_buffer_set_highlight_diagnostics (IdeBuffer *self,
/**
* ide_buffer_get_diagnostic_at_iter:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @iter: a #GtkTextIter.
*
* Gets the first diagnostic that overlaps the position
......@@ -2111,7 +2111,7 @@ ide_buffer_can_do_newline_hack (IdeBuffer *self,
/**
* ide_buffer_get_content:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the contents of the buffer as GBytes.
*
......@@ -2187,7 +2187,7 @@ ide_buffer_get_content (IdeBuffer *self)
/**
* ide_buffer_trim_trailing_whitespace:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Trim trailing whitespaces from the buffer.
*
......@@ -2263,7 +2263,7 @@ ide_buffer_trim_trailing_whitespace (IdeBuffer *self)
/**
* ide_buffer_get_title:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:title property. This property contains a title for the buffer suitable
* for display.
......@@ -2282,7 +2282,7 @@ ide_buffer_get_title (IdeBuffer *self)
/**
* ide_buffer_get_style_scheme_name:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:style-scheme-name property.
* This property contains the current style scheme used by the buffer.
......@@ -2305,7 +2305,7 @@ ide_buffer_get_style_scheme_name (IdeBuffer *self)
/**
* ide_buffer_set_style_scheme_name:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @style_scheme_name: A string containing the name of the style scheme to use.
*
* Sets the #IdeBuffer:style-scheme-name property.
......@@ -2362,7 +2362,7 @@ _ide_buffer_set_loading (IdeBuffer *self,
/**
* ide_buffer_get_read_only:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the #IdeBuffer:read-only property. This property indicate if the underlying file is read only or not.
*
......@@ -2397,7 +2397,7 @@ _ide_buffer_set_read_only (IdeBuffer *self,
/**
* ide_buffer_get_changed_on_volume:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets if the file backing the buffer has changed on the underlying storage.
*
......@@ -2476,7 +2476,7 @@ ide_buffer__check_for_volume_cb (GObject *object,
/**
* ide_buffer_check_for_volume_change:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Update the #IdeBuffer:read-only property and the corresponding
* modification time (mtime).
......@@ -2534,7 +2534,7 @@ _ide_buffer_set_mtime (IdeBuffer *self,
/**
* ide_buffer_get_iter_at_source_location:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @iter: (out): a #GtkTextIter.
* @location: a #IdeSourceLocation.
*
......@@ -2561,7 +2561,7 @@ ide_buffer_get_iter_at_source_location (IdeBuffer *self,
/**
* ide_buffer_rehighlight:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Force the #IdeBuffer to rebuild the highlight.
*
......@@ -2655,7 +2655,7 @@ ide_buffer_get_symbol_at_location_cb (GObject *object,
/**
* ide_buffer_get_symbol_at_location_async:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @location: a #GtkTextIter indicating a position to search for a symbol.
* @cancellable: A #GCancellable.
* @callback: A #GAsyncReadyCallback.
......@@ -2728,7 +2728,7 @@ ide_buffer_get_symbol_at_location_async (IdeBuffer *self,
/**
* ide_buffer_get_symbol_at_location_finish:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @result: A #GAsyncResult.
* @error: (out): A #GError.
*
......@@ -2749,7 +2749,7 @@ ide_buffer_get_symbol_at_location_finish (IdeBuffer *self,
/**
* ide_buffer_get_symbols_finish:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Returns: (transfer container) (element-type IdeSymbol*): A #GPtrArray if successful;
* otherwise %NULL.
......@@ -2841,7 +2841,7 @@ ide_buffer_release (IdeBuffer *self)
/**
* ide_buffer_get_selection_bounds:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @insert: (out): A #GtkTextIter to get the insert position.
* @selection: (out): A #GtkTextIter to get the selection position.
*
......@@ -2897,7 +2897,7 @@ ide_buffer_get_rename_provider (IdeBuffer *self)
/**
* ide_buffer_get_symbol_resolvers:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
*
* Gets the symbol resolvers for the buffer based on the current language.
*
......@@ -2915,7 +2915,7 @@ ide_buffer_get_symbol_resolvers (IdeBuffer *self)
/**
* ide_buffer_get_word_at_iter:
* @self: A #IdeBuffer.
* @self: an #IdeBuffer.
* @iter: A #GtkTextIter.
*
* Gets the word found under the position denoted by @iter.
......
......@@ -128,7 +128,7 @@ ide_unsaved_file_unref (IdeUnsavedFile *self)
/**
* ide_unsaved_file_get_content:
* @self: A #IdeUnsavedFile.
* @self: an #IdeUnsavedFile.
*
* Gets the contents of the unsaved file.
*
......
......@@ -1808,7 +1808,7 @@ ide_build_pipeline_execute_finish (IdeBuildPipeline *self,
/**
* ide_build_pipeline_connect:
* @self: A #IdeBuildPipeline
* @self: an #IdeBuildPipeline
* @phase: An #IdeBuildPhase
* @priority: an optional priority for sorting within the phase
* @stage: An #IdeBuildStage
......@@ -1880,7 +1880,7 @@ cleanup:
/**
* ide_build_pipeline_connect_launcher:
* @self: A #IdeBuildPipeline
* @self: an #IdeBuildPipeline
* @phase: An #IdeBuildPhase
* @priority: an optional priority for sorting within the phase
* @launcher: An #IdeSubprocessLauncher
......@@ -2297,7 +2297,7 @@ ide_build_pipeline_emit_diagnostic (IdeBuildPipeline *self,
/**
* ide_build_pipeline_add_error_format:
* @self: A #IdeBuildPipeline
* @self: an #IdeBuildPipeline
* @regex: A regex to be compiled
*
* This can be used to add a regex that will extract errors from
......
......@@ -76,7 +76,7 @@ struct _IdeBuildStageClass
/**
* IdeBuildStage::clean_async:
* @self: A #IdeBuildStage
* @self: an #IdeBuildStage
* @pipeline: An #IdeBuildPipeline
* @cancellable: (nullable): A #GCancellable or %NULL
* @callback: An async callback
......@@ -92,7 +92,7 @@ struct _IdeBuildStageClass
/**
* IdeBuildStage::clean_finish:
* @self: A #IdeBuildStage
* @self: an #IdeBuildStage
* @result: A #GErrorResult
* @error: A location for a #GError or %NULL.
*
......
......@@ -1543,7 +1543,7 @@ ide_configuration_get_internal_object (IdeConfiguration *self,
/**
* ide_configuration_set_internal_object:
* @self: A #IdeConfiguration
* @self: an #IdeConfiguration
* @key: the key to set
* @instance: (type GObject.Object) (nullable): A #GObject or %NULL
*
......
......@@ -226,7 +226,7 @@ ide_diagnostic_new (IdeDiagnosticSeverity severity,
/**
* ide_diagnostic_take_fixit:
* @self: A #IdeDiagnostic.
* @self: an #IdeDiagnostic.
* @fixit: (transfer full): An #IdeFixit.
*
* Adds the suggested fixit to the diagnostic while transfering ownership
......@@ -247,7 +247,7 @@ ide_diagnostic_take_fixit (IdeDiagnostic *self,
/**
* ide_diagnostic_take_range:
* @self: A #IdeDiagnostic.
* @self: an #IdeDiagnostic.
* @range: (transfer full): An #IdeSourceRange.
*
* Steals the ownership of @range and adds to the diagnostic.
......@@ -327,7 +327,7 @@ ide_diagnostic_get_num_fixits (IdeDiagnostic *self)
/**
* ide_diagnostic_get_fixit:
* @self: A #IdeDiagnostic.
* @self: an #IdeDiagnostic.
* @index: The index of the fixit.
*
* Gets the fixit denoted by @index. This value should be less than the value
......
......@@ -581,7 +581,7 @@ ide_diagnostics_manager_class_init (IdeDiagnosticsManagerClass *klass)
/**
* IdeDiagnosticsManager::changed:
* @self: A #IdeDiagnosticsManager
* @self: an #IdeDiagnosticsManager
*
* This signal is emitted when the diagnostics have changed for any
* file managed by the IdeDiagnosticsManager.
......
......@@ -89,7 +89,7 @@ ide_fixit_apply (IdeFixit *self)
/**
* ide_fixit_get_text:
* @self: A #IdeFixit.
* @self: an #IdeFixit.
*
* Gets the text to replace the source range with.
*
......@@ -105,7 +105,7 @@ ide_fixit_get_text (IdeFixit *self)
/**
* ide_fixit_get_range:
* @self: A #IdeFixit.
* @self: an #IdeFixit.
*
* Gets the range for the replacement text. The range is non inclusive of the
* end location. [a,b)
......
......@@ -171,7 +171,7 @@ ide_source_location_new (IdeFile *file,
/**
* ide_source_location_get_uri:
* @self: (in): A #IdeSourceLocation.
* @self: (in): an #IdeSourceLocation.
*
* Returns: (transfer full): A newly allocated #IdeUri.
*/
......
......@@ -586,7 +586,7 @@ ide_editor_perspective_get_active_view (IdeEditorPerspective *self)
*
* Gets the #IdeEditorSidebar for the editor perspective.
*
* Returns: (transfer none): A #IdeEditorSidebar
* Returns: (transfer none): an #IdeEditorSidebar
*
* Since: 3.26
*/
......
......@@ -399,7 +399,7 @@ ide_editor_properties_init (IdeEditorProperties *self)
*
* Creates a new #IdeEditorProperties.
*
* Returns: (transfer full): A #IdeEditorProperties
* Returns: (transfer full): an #IdeEditorProperties
*
* Since: 3.26
*/
......
......@@ -186,7 +186,7 @@ ide_file_set_file (IdeFile *self,
/**
* _ide_file_get_source_file:
* @self: (in): A #IdeFile.
* @self: (in): an #IdeFile.
*
* Gets the GtkSourceFile for the #IdeFile.
*
......@@ -337,7 +337,7 @@ ide_file_load_settings_finish (IdeFile *self,
/**
* ide_file_get_temporary_id:
* @self: (in): A #IdeFile.
* @self: (in): an #IdeFile.
*
* Gets the #IdeFile:temporary-id property for the file.
*
......
......@@ -952,7 +952,7 @@ ide_highlight_engine_new (IdeBuffer *buffer)
/**
* ide_highlight_engine_get_highlighter:
* @self: A #IdeHighlightEngine.
* @self: an #IdeHighlightEngine.
*
* Gets the IdeHighlightEngine:highlighter property.
*
......@@ -968,7 +968,7 @@ ide_highlight_engine_get_highlighter (IdeHighlightEngine *self)
/**
* ide_highlight_engine_get_buffer:
* @self: A #IdeHighlightEngine.
* @self: an #IdeHighlightEngine.
*
* Gets the IdeHighlightEngine:buffer property.
*
......
......@@ -54,7 +54,7 @@ ide_highlighter_default_init (IdeHighlighterInterface *iface)
/**
* ide_highlighter_update:
* @self: A #IdeHighlighter.
* @self: an #IdeHighlighter.
* @callback: (scope call): A callback to apply a given style.
* @range_begin: The beginning of the range to update.
* @range_end: The end of the range to update.
......
......@@ -249,7 +249,7 @@ ide_context_get_device_manager (IdeContext *self)
*
* Returns the #IdeDocumentation for the source view if there is one.
*
* Returns: (transfer none) (nullable): A #IdeDocumentation or %NULL.
* Returns: (transfer none) (nullable): an #IdeDocumentation or %NULL.
*/
IdeDocumentation *
ide_context_get_documentation (IdeContext *self)
......
......@@ -28,7 +28,7 @@
/**
* SECTION:ide-object
* @title: IdeObject
* @short_description: Base object for #IdeContext-related objects
* @short_description: Base object for #IdeContext related objects
*
* The #IdeObject abstract class provides a base class for ojects that are
* related to #IdeContext. It provides easy access to the #IdeContext using
......
......@@ -1237,7 +1237,7 @@ ide_langserv_client_get_diagnostics_async (IdeLangservClient *self,
/**
* ide_langserv_client_get_diagnostics_finish:
* @self: A #IdeLangservClient
* @self: an #IdeLangservClient
* @result: A #GAsyncResult
* @diagnostics: (nullable) (out): A location for a #IdeDiagnostics or %NULL
* @error: A location for a #GError or %NULL
......
......@@ -354,7 +354,7 @@ rename_provider_iface_init (IdeRenameProviderInterface *iface)
/**
* ide_langserv_rename_provider_get_client:
*
* Returns: (transfer none) (nullable): A #IdeLangservClient or %NULL.
* Returns: (transfer none) (nullable): an #IdeLangservClient or %NULL.
*/
IdeLangservClient *
ide_langserv_rename_provider_get_client (IdeLangservRenameProvider *self)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment