[virt-tools-list] [libosinfo v3 2/3] docs: Fix typos
Fabiano Fidêncio
fabiano at fidencio.org
Tue Dec 18 03:20:19 UTC 2012
- a -> an
- add a missing word (elements)
- references: @param: an Osinfo* -> @param: an #Osinfo*
---
osinfo/osinfo_avatar_format.c | 2 +-
osinfo/osinfo_db.c | 10 +++++-----
osinfo/osinfo_deployment.h | 2 +-
osinfo/osinfo_device_driver.c | 10 +++++-----
osinfo/osinfo_devicelink.c | 2 +-
osinfo/osinfo_entity.c | 14 +++++++-------
osinfo/osinfo_filter.c | 2 +-
osinfo/osinfo_install_config_param.c | 2 +-
osinfo/osinfo_install_script.c | 4 ++--
osinfo/osinfo_list.c | 4 ++--
osinfo/osinfo_media.c | 30 +++++++++++++++---------------
osinfo/osinfo_os.c | 4 ++--
osinfo/osinfo_resources.c | 18 +++++++++---------
osinfo/osinfo_tree.c | 18 +++++++++---------
14 files changed, 61 insertions(+), 61 deletions(-)
diff --git a/osinfo/osinfo_avatar_format.c b/osinfo/osinfo_avatar_format.c
index 81436df..8c93bfb 100644
--- a/osinfo/osinfo_avatar_format.c
+++ b/osinfo/osinfo_avatar_format.c
@@ -171,7 +171,7 @@ osinfo_avatar_format_init (OsinfoAvatarFormat *avatar)
/**
* osinfo_avatar_format_new:
*
- * Construct a new user avatar file to a #OsinfoInstallScript.
+ * Construct a new user avatar file to an #OsinfoInstallScript.
*
* Returns: (transfer full): the necessary information to create an avatar for
* an user
diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index 2015106..e3f6f45 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -493,7 +493,7 @@ void osinfo_db_add_deployment(OsinfoDb *db, OsinfoDeployment *deployment)
/**
* osinfo_db_add_datamap:
* @db: the database
- * @datamap: (transfer none): a install datamap
+ * @datamap: (transfer none): an install datamap
*
*/
void osinfo_db_add_datamap(OsinfoDb *db, OsinfoDatamap *datamap)
@@ -508,7 +508,7 @@ void osinfo_db_add_datamap(OsinfoDb *db, OsinfoDatamap *datamap)
/**
* osinfo_db_add_install_script:
* @db: the database
- * @script: (transfer none): a install script
+ * @script: (transfer none): an install script
*
*/
void osinfo_db_add_install_script(OsinfoDb *db, OsinfoInstallScript *script)
@@ -604,7 +604,7 @@ osinfo_db_guess_os_from_media_internal(OsinfoDb *db,
* @matched_media: (out) (transfer none) (allow-none): the matched operating
* system media
*
- * Guess operating system given a #OsinfoMedia object.
+ * Guess operating system given an #OsinfoMedia object.
*
* Returns: (transfer none): the operating system, or NULL if guessing failed
* Deprecated: 0.2.3: Use osinfo_db_identify_media() instead.
@@ -664,7 +664,7 @@ static void fill_media (OsinfoDb *db, OsinfoMedia *media,
/**
* osinfo_db_identify_media:
- * @db: a #OsinfoDb database
+ * @db: an #OsinfoDb database
* @media: the installation media
* data
*
@@ -703,7 +703,7 @@ gboolean osinfo_db_identify_media(OsinfoDb *db, OsinfoMedia *media)
* @matched_tree: (out) (transfer none) (allow-none): the matched operating
* system tree
*
- * Guess operating system given a #OsinfoTree object.
+ * Guess operating system given an #OsinfoTree object.
*
* Returns: (transfer none): the operating system, or NULL if guessing failed
*/
diff --git a/osinfo/osinfo_deployment.h b/osinfo/osinfo_deployment.h
index 70c170e..45a9d14 100644
--- a/osinfo/osinfo_deployment.h
+++ b/osinfo/osinfo_deployment.h
@@ -1,5 +1,5 @@
/*
- * libosinfo: a operating system deployment for a platform
+ * libosinfo: an operating system deployment for a platform
*
* Copyright (C) 2009-2012 Red Hat, Inc.
*
diff --git a/osinfo/osinfo_device_driver.c b/osinfo/osinfo_device_driver.c
index 9a7e5e2..d402bc7 100644
--- a/osinfo/osinfo_device_driver.c
+++ b/osinfo/osinfo_device_driver.c
@@ -95,7 +95,7 @@ OsinfoDeviceDriver *osinfo_device_driver_new(const gchar *id)
/**
* osinfo_device_driver_get_architecture:
- * @driver: a #OsinfoDeviceDriver instance
+ * @driver: an #OsinfoDeviceDriver instance
*
* Retrieves the target hardware architecture of @driver.
*
@@ -109,7 +109,7 @@ const gchar *osinfo_device_driver_get_architecture(OsinfoDeviceDriver *driver)
/**
* osinfo_device_driver_get_location:
- * @driver: a #OsinfoDeviceDriver instance
+ * @driver: an #OsinfoDeviceDriver instance
*
* Retrieves the location of the @driver as a URL.
*
@@ -123,7 +123,7 @@ const gchar *osinfo_device_driver_get_location(OsinfoDeviceDriver *driver)
/**
* osinfo_device_driver_get_files:
- * @driver: a #OsinfoDeviceDriver instance
+ * @driver: an #OsinfoDeviceDriver instance
*
* Retrieves the names of driver files under the location returned by
* #osinfo_device_driver_get_location.
@@ -138,7 +138,7 @@ GList *osinfo_device_driver_get_files(OsinfoDeviceDriver *driver)
/**
* osinfo_device_driver_get_pre_installable:
- * @driver: a #OsinfoDeviceDriver instance
+ * @driver: an #OsinfoDeviceDriver instance
*
* Returns: TRUE if @driver is pre-installable, FALSE otherwise.
*/
@@ -151,7 +151,7 @@ gboolean osinfo_device_driver_get_pre_installable(OsinfoDeviceDriver *driver)
/**
* osinfo_device_driver_get_devices:
- * @driver: a #OsinfoDeviceDriver instance
+ * @driver: an #OsinfoDeviceDriver instance
*
* Returns: (transfer none): The list of devices supported by this driver.
*/
diff --git a/osinfo/osinfo_devicelink.c b/osinfo/osinfo_devicelink.c
index 383c7f2..9b0a21b 100644
--- a/osinfo/osinfo_devicelink.c
+++ b/osinfo/osinfo_devicelink.c
@@ -152,7 +152,7 @@ osinfo_devicelink_init (OsinfoDeviceLink *devlink)
* osinfo_devicelink_new:
* @target: the target device
*
- * Construct a new link to a #OsinfoDevice. The unique ID
+ * Construct a new link to an #OsinfoDevice. The unique ID
* of the link is set to match the ID of the target device.
*
* Returns: (transfer full): the new device link
diff --git a/osinfo/osinfo_entity.c b/osinfo/osinfo_entity.c
index f108447..dc5a965 100644
--- a/osinfo/osinfo_entity.c
+++ b/osinfo/osinfo_entity.c
@@ -173,7 +173,7 @@ osinfo_entity_init (OsinfoEntity *entity)
/**
* osinfo_entity_set_param:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
* @key: the name of the key
* @value: the data to associated with that key
*
@@ -226,7 +226,7 @@ void osinfo_entity_set_param_enum(OsinfoEntity *entity, const gchar *key, gint v
/**
* osinfo_entity_add_param:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
* @key: the name of the key
* @value: the data to associated with that key
*
@@ -260,7 +260,7 @@ void osinfo_entity_add_param(OsinfoEntity *entity, const gchar *key, const gchar
/**
* osinfo_entity_clear_param:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
* @key: the name of the key
*
* Remove all values associated with a key
@@ -272,7 +272,7 @@ void osinfo_entity_clear_param(OsinfoEntity *entity, const gchar *key)
/**
* osinfo_entity_get_id:
- * @entity: a OsinfoEntity
+ * @entity: an #OsinfoEntity
*
* Retrieves the unique key for the entity. The format of identifiers
* is undefined, but the recommended practice is to use a URI.
@@ -289,7 +289,7 @@ const gchar *osinfo_entity_get_id(OsinfoEntity *entity)
/**
* osinfo_entity_get_param_keys:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
*
* Retrieve all the known parameter keys associated with
* the entity
@@ -308,7 +308,7 @@ GList *osinfo_entity_get_param_keys(OsinfoEntity *entity)
/**
* osinfo_entity_get_param_value:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
* @key: the name of the key
*
* Retrieve the parameter value associated with a named key. If
@@ -406,7 +406,7 @@ gint osinfo_entity_get_param_value_enum(OsinfoEntity *entity,
/**
* osinfo_entity_get_param_value_list:
- * @entity: OsinfoEntity containing the parameters
+ * @entity: an #OsinfoEntity containing the parameters
* @key: the name of the key
*
* Retrieve all the parameter values associated with a named
diff --git a/osinfo/osinfo_filter.c b/osinfo/osinfo_filter.c
index 7f4dc56..6f19ec1 100644
--- a/osinfo/osinfo_filter.c
+++ b/osinfo/osinfo_filter.c
@@ -276,7 +276,7 @@ static gboolean osinfo_filter_matches_default(OsinfoFilter *filter, OsinfoEntity
/**
* osinfo_filter_matches:
* @filter: a filter object
- * @entity: a entity to query
+ * @entity: an entity to query
*
* Determine of an entity matches a filter
*
diff --git a/osinfo/osinfo_install_config_param.c b/osinfo/osinfo_install_config_param.c
index 7876d20..0f9911f 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -156,7 +156,7 @@ osinfo_install_config_param_init (OsinfoInstallConfigParam *config_param)
* osinfo_install_config_param_new:
* @name: the configuration parameter name
*
- * Construct a new configuration parameter to a #OsinfoInstallScript.
+ * Construct a new configuration parameter to an #OsinfoInstallScript.
*
* Returns: (transfer full): the new configuration parameter
*/
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index da92850..23e3c5a 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -507,7 +507,7 @@ osinfo_install_script_set_avatar_format(OsinfoInstallScript *script,
}
/**
- * osinfo_install_script_get_avatar_format
+ * osinfo_install_script_get_avatar_format:
* @script: the install script
*
* Some install scripts have restrictions on the format of the user avatar. Use
@@ -1097,7 +1097,7 @@ void osinfo_install_script_generate_output_async(OsinfoInstallScript *script,
* @cancellable: (allow-none): a #GCancellable, or %NULL
* @error: The location where to store any error, or %NULL
*
- * Creates a install script written in a file
+ * Creates an install script written in a file
*
* Returns: (transfer full): a file containing the script
*/
diff --git a/osinfo/osinfo_list.c b/osinfo/osinfo_list.c
index 25716c9..c32a5ff 100644
--- a/osinfo/osinfo_list.c
+++ b/osinfo/osinfo_list.c
@@ -448,8 +448,8 @@ OsinfoList *osinfo_list_new_filtered(OsinfoList *source, OsinfoFilter *filter)
* @sourceOne: the first list to copy
* @sourceTwo: the second list to copy
*
- * Construct a new list that is filled with only the
- * s that are present in both @sourceOne and @sourceTwo.
+ * Construct a new list that is filled with only the elements
+ * that are present in both @sourceOne and @sourceTwo.
*
* Returns: (transfer full): an intersection of the two lists
*/
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index 2821e7f..8f03046 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -464,11 +464,11 @@ osinfo_media_class_init (OsinfoMediaClass *klass)
/**
* OsinfoMedia:installer:
*
- * Whether media provides a installer for an OS.
+ * Whether media provides an installer for an OS.
*/
pspec = g_param_spec_boolean ("installer",
"Installer",
- _("Media provides a installer"),
+ _("Media provides an installer"),
TRUE /* default value */,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS);
@@ -926,7 +926,7 @@ OsinfoMedia *osinfo_media_create_from_location_finish(GAsyncResult *res,
/**
* osinfo_media_get_architecture:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* Retrieves the target hardware architecture of the OS @media provides.
*
@@ -940,7 +940,7 @@ const gchar *osinfo_media_get_architecture(OsinfoMedia *media)
/**
* osinfo_media_get_url:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* The URL to the @media
*
@@ -954,7 +954,7 @@ const gchar *osinfo_media_get_url(OsinfoMedia *media)
/**
* osinfo_media_get_volume_id:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If @media is an ISO9660 image/device, this function retrieves the expected
* volume ID.
@@ -973,7 +973,7 @@ const gchar *osinfo_media_get_volume_id(OsinfoMedia *media)
/**
* osinfo_media_get_system_id:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If @media is an ISO9660 image/device, this function retrieves the expected
* system ID.
@@ -992,7 +992,7 @@ const gchar *osinfo_media_get_system_id(OsinfoMedia *media)
/**
* osinfo_media_get_publisher_id:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If @media is an ISO9660 image/device, this function retrieves the expected
* publisher ID.
@@ -1011,7 +1011,7 @@ const gchar *osinfo_media_get_publisher_id(OsinfoMedia *media)
/**
* osinfo_media_get_application_id:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If @media is an ISO9660 image/device, this function retrieves the expected
* application ID.
@@ -1030,7 +1030,7 @@ const gchar *osinfo_media_get_application_id(OsinfoMedia *media)
/**
* osinfo_media_get_kernel_path:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* Retrieves the path to the kernel image in the install tree.
*
@@ -1046,7 +1046,7 @@ const gchar *osinfo_media_get_kernel_path(OsinfoMedia *media)
/**
* osinfo_media_get_initrd_path:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* Retrieves the path to the initrd image in the install tree.
*
@@ -1062,9 +1062,9 @@ const gchar *osinfo_media_get_initrd_path(OsinfoMedia *media)
/**
* osinfo_media_get_installer:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
- * Whether @media provides a installer for an OS.
+ * Whether @media provides an installer for an OS.
*
* Returns: #TRUE if media is installer, #FALSE otherwise
*/
@@ -1076,7 +1076,7 @@ gboolean osinfo_media_get_installer(OsinfoMedia *media)
/**
* osinfo_media_get_live:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* Whether @media can boot directly an OS without any installations.
*
@@ -1090,7 +1090,7 @@ gboolean osinfo_media_get_live(OsinfoMedia *media)
/**
* osinfo_media_get_installer_reboots:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If media is an installer, this method retrieves the number of reboots the
* installer takes before installation is complete.
@@ -1138,7 +1138,7 @@ void osinfo_media_set_os(OsinfoMedia *media, OsinfoOs *os)
/**
* osinfo_media_get_languages:
- * @media: a #OsinfoMedia instance
+ * @media: an #OsinfoMedia instance
*
* If media is an installer, this property indicates the languages that
* can be used during automatic installations.
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 786e596..97c33f7 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -368,7 +368,7 @@ OsinfoDeviceLink *osinfo_os_add_device(OsinfoOs *os, OsinfoDevice *dev)
/**
* osinfo_os_get_family:
- * @os: a OsinfoOs
+ * @os: an #OsinfoOs
*
* Retrieves the generic family the OS @os belongs to, based upon its kernel,
* for example linux, winnt, solaris, freebsd etc.
@@ -384,7 +384,7 @@ const gchar *osinfo_os_get_family(OsinfoOs *os)
/**
* osinfo_os_get_distro:
- * @os: a OsinfoOs
+ * @os: an #OsinfoOs
*
* Retrieves the generic family the OS @os belongs to, for example fedora,
* ubuntu, windows, solaris, freebsd etc.
diff --git a/osinfo/osinfo_resources.c b/osinfo/osinfo_resources.c
index 1cdc888..67d9952 100644
--- a/osinfo/osinfo_resources.c
+++ b/osinfo/osinfo_resources.c
@@ -267,7 +267,7 @@ OsinfoResources *osinfo_resources_new(const gchar *id,
/**
* osinfo_resources_get_architecture:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
*
* Retrieves the target hardware architecture to which @resources applies. Some
* operating systems specify the same requirements and recommendations for all
@@ -284,7 +284,7 @@ const gchar *osinfo_resources_get_architecture(OsinfoResources *resources)
/**
* osinfo_resources_get_n_cpus:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
*
* Retrieves the number of CPUs.
*
@@ -298,7 +298,7 @@ gint osinfo_resources_get_n_cpus(OsinfoResources *resources)
/**
* osinfo_resources_get_cpu:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
*
* Retrieves the CPU frequency in hertz (Hz). Divide the value by #OSINFO_MEGAHERTZ if
* you need this value in megahertz (MHz).
@@ -313,7 +313,7 @@ gint64 osinfo_resources_get_cpu(OsinfoResources *resources)
/**
* osinfo_resources_get_ram:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
*
* Retrieves the amount of Random Access Memory (RAM) in bytes. Divide the value
* by #OSINFO_MEBIBYTES if you need this value in mebibytes.
@@ -328,7 +328,7 @@ gint64 osinfo_resources_get_ram(OsinfoResources *resources)
/**
* osinfo_resources_get_storage:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
*
* Retrieves the amount of storage space in bytes. Divide the value by
* #OSINFO_GIBIBYTES if you need this value in gibibytes.
@@ -343,7 +343,7 @@ gint64 osinfo_resources_get_storage(OsinfoResources *resources)
/**
* osinfo_resources_set_n_cpus:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
* @n_cpus: the number of CPUs
*
* Sets the number of CPUs.
@@ -357,7 +357,7 @@ void osinfo_resources_set_n_cpus(OsinfoResources *resources, gint n_cpus)
/**
* osinfo_resources_set_cpu:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
* @cpu: the CPU frequency in hertz (Hz)
*
* Sets the CPU frequency.
@@ -371,7 +371,7 @@ void osinfo_resources_set_cpu(OsinfoResources *resources, gint64 cpu)
/**
* osinfo_resources_set_ram:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
* @ram: the amount of ram in bytes
*
* Sets the amount of RAM in bytes.
@@ -385,7 +385,7 @@ void osinfo_resources_set_ram(OsinfoResources *resources, gint64 ram)
/**
* osinfo_resources_set_storage:
- * @resources: a #OsinfoResources instance
+ * @resources: an #OsinfoResources instance
* @storage: the amount of storage in bytes
*
* Sets the amount of storage space.
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index 3b964a1..fe8e659 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -698,7 +698,7 @@ OsinfoTree *osinfo_tree_create_from_location_finish(GAsyncResult *res,
/**
* osinfo_tree_get_architecture:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* Retrieves the target hardware architecture of the OS @tree provides.
*
@@ -712,7 +712,7 @@ const gchar *osinfo_tree_get_architecture(OsinfoTree *tree)
/**
* osinfo_tree_get_url:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* The URL to the @tree
*
@@ -726,7 +726,7 @@ const gchar *osinfo_tree_get_url(OsinfoTree *tree)
/**
* osinfo_tree_get_treeinfo_family:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* If @tree is an ISO9660 image/device, this function retrieves the expected
* volume ID.
@@ -745,7 +745,7 @@ const gchar *osinfo_tree_get_treeinfo_family(OsinfoTree *tree)
/**
* osinfo_tree_get_treeinfo_arch:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* If @tree is an ISO9660 image/device, this function retrieves the expected
* system ID.
@@ -764,7 +764,7 @@ const gchar *osinfo_tree_get_treeinfo_arch(OsinfoTree *tree)
/**
* osinfo_tree_get_treeinfo_variant:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* If @tree is an ISO9660 image/device, this function retrieves the expected
* publisher ID.
@@ -783,7 +783,7 @@ const gchar *osinfo_tree_get_treeinfo_variant(OsinfoTree *tree)
/**
* osinfo_tree_get_treeinfo_version:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* If @tree is an ISO9660 image/device, this function retrieves the expected
* application ID.
@@ -802,7 +802,7 @@ const gchar *osinfo_tree_get_treeinfo_version(OsinfoTree *tree)
/**
* osinfo_tree_get_boot_iso_path:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* Retrieves the path to the boot_iso image in the install tree.
*
@@ -816,7 +816,7 @@ const gchar *osinfo_tree_get_boot_iso_path(OsinfoTree *tree)
/**
* osinfo_tree_get_kernel_path:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* Retrieves the path to the kernel image in the install tree.
*
@@ -832,7 +832,7 @@ const gchar *osinfo_tree_get_kernel_path(OsinfoTree *tree)
/**
* osinfo_tree_get_initrd_path:
- * @tree: a #OsinfoTree instance
+ * @tree: an #OsinfoTree instance
*
* Retrieves the path to the initrd image in the install tree.
*
--
1.8.0.2
More information about the virt-tools-list
mailing list