Commit 24da0007 authored by Michael Natterer's avatar Michael Natterer

libgimp*: some API doc fixes

parent 68942a63
......@@ -746,8 +746,8 @@ gimp_metadata_set_pixel_size (GimpMetadata *metadata,
/**
* gimp_metadata_set_bits_per_sample:
* @metadata: A #GimpMetadata instance.
* @bps: Bytes per pixel, per component
* @metadata: A #GimpMetadata instance.
* @bits_per_sample: Bits per pixel, per component
*
* Sets Exif.Image.BitsPerSample on @metadata.
*
......@@ -755,13 +755,14 @@ gimp_metadata_set_pixel_size (GimpMetadata *metadata,
*/
void
gimp_metadata_set_bits_per_sample (GimpMetadata *metadata,
gint bps)
gint bits_per_sample)
{
gchar buffer[32];
g_return_if_fail (GEXIV2_IS_METADATA (metadata));
g_snprintf (buffer, sizeof (buffer), "%d %d %d", bps, bps, bps);
g_snprintf (buffer, sizeof (buffer), "%d %d %d",
bits_per_sample, bits_per_sample, bits_per_sample);
gexiv2_metadata_set_tag_string (metadata, "Exif.Image.BitsPerSample", buffer);
}
......
......@@ -30,7 +30,7 @@
/**
* SECTION:value_arrays
* SECTION:gimpvaluearray
* @short_description: A container structure to maintain an array of
* generic values
* @see_also: #GValue, #GParamSpecValueArray, gimp_param_spec_value_array()
......@@ -72,11 +72,11 @@ G_DEFINE_BOXED_TYPE (GimpValueArray, gimp_value_array,
/**
* gimp_value_array_index:
* @value_array: #GimpValueArray to get a value from
* @index_: index of the value of interest
* @index: index of the value of interest
*
* Return a pointer to the value at @index_ containd in @value_array.
* Return a pointer to the value at @index containd in @value_array.
*
* Returns: (transfer none): pointer to a value at @index_ in @value_array
* Returns: (transfer none): pointer to a value at @index in @value_array
*
* Since: GIMP 2.10
*/
......@@ -156,6 +156,8 @@ gimp_value_array_new (gint n_prealloced)
*
* Adds a reference to a #GimpValueArray.
*
* Return value: the same @value_array
*
* Since: GIMP 2.10
*/
GimpValueArray *
......@@ -253,7 +255,7 @@ gimp_value_array_append (GimpValueArray *value_array,
/**
* gimp_value_array_insert:
* @value_array: #GimpValueArray to add an element to
* @index_: insertion position, must be <= value_array->n_values
* @index: insertion position, must be <= value_array->n_values
* @value: (allow-none): #GValue to copy into #GimpValueArray, or %NULL
*
* Insert a copy of @value at specified position into @value_array. If @value
......@@ -294,11 +296,11 @@ gimp_value_array_insert (GimpValueArray *value_array,
/**
* gimp_value_array_remove:
* @value_array: #GimpValueArray to remove an element from
* @index_: position of value to remove, which must be less than
* <code>value_array-><link
* linkend="GimpValueArray.n-values">n_values</link></code>
* @index: position of value to remove, which must be less than
* <code>value_array-><link
* linkend="GimpValueArray.n-values">n_values</link></code>
*
* Remove the value at position @index_ from @value_array.
* Remove the value at position @index from @value_array.
*
* Returns: (transfer none): the #GimpValueArray passed in as @value_array
*
......
......@@ -341,14 +341,14 @@ gimp_config_serialize_to_gfile (GimpConfig *config,
/**
* gimp_config_serialize_to_stream:
* @config: a #GObject that implements the #GimpConfigInterface.
* @stream: the #GOutputStream to write the configuration to.
* @output: the #GOutputStream to write the configuration to.
* @header: optional file header (must be ASCII only)
* @footer: optional file footer (must be ASCII only)
* @data: user data passed to the serialize implementation.
* @error: return location for a possible error
*
* Serializes the object properties of @config to the stream specified
* by @stream.
* by @output.
*
* Return value: %TRUE if serialization succeeded, %FALSE otherwise.
*
......
......@@ -468,11 +468,11 @@ gimp_vector2_rotate_val (GimpVector2 vector,
* Compute a normalized perpendicular vector to @vector
*
* Returns: a #GimpVector2 perpendicular to @vector, with a length of 1.0.
*
* Since: 2.8
*
* Since: GIMP 2.8
**/
GimpVector2
gimp_vector2_normal (GimpVector2 *vector)
gimp_vector2_normal (GimpVector2 *vector)
{
GimpVector2 result;
......@@ -493,10 +493,10 @@ gimp_vector2_normal (GimpVector2 *vector)
*
* Returns: a #GimpVector2 perpendicular to @vector, with a length of 1.0.
*
* Since: 2.8
* Since: GIMP 2.8
**/
GimpVector2
gimp_vector2_normal_val (GimpVector2 vector)
gimp_vector2_normal_val (GimpVector2 vector)
{
GimpVector2 result;
......
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