Skip to content

Commit 073fc5d

Browse files
mmathesiussgallagher
mmathesius
authored and
sgallagher
committed
Another batch of documentation updates for private functions, along with other
minor corrections. Signed-off-by: Merlin Mathesius <mmathesi@redhat.com>
1 parent 7543e78 commit 073fc5d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+630
-440
lines changed

‎modulemd/v2/include/modulemd-2.0/modulemd-buildopts.h‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ G_DECLARE_FINAL_TYPE (
3232
/**
3333
* modulemd_buildopts_new:
3434
*
35-
* Returns: (transfer full): A newly-allocated #ModulemdBuildopts. This object
36-
* must be freed with g_object_unref().
35+
* Returns: (transfer full): A newly-allocated #ModulemdBuildopts object. This
36+
* object must be freed with g_object_unref().
3737
*
3838
* Since: 2.0
3939
*/
@@ -43,10 +43,10 @@ modulemd_buildopts_new (void);
4343

4444
/**
4545
* modulemd_buildopts_equals:
46-
* @self_1: A #ModulemdBuildopts
47-
* @self_2: A #ModulemdBuildopts
46+
* @self_1: A #ModulemdBuildopts object.
47+
* @self_2: A #ModulemdBuildopts object.
4848
*
49-
* Check for equality for 2 ModulemdBuildopts objects.
49+
* Check for equality for two #ModulemdBuildopts objects.
5050
*
5151
* Returns: TRUE if both objects are equal, FALSE otherwise.
5252
*
@@ -59,11 +59,12 @@ modulemd_buildopts_equals (ModulemdBuildopts *self_1,
5959

6060
/**
6161
* modulemd_buildopts_copy:
62-
* @self: This #ModulemdBuildopts
62+
* @self: This #ModulemdBuildopts object.
6363
*
6464
* Create a copy of this #ModulemdBuildopts object.
6565
*
66-
* Returns: (transfer full): a copied #ModulemdBuildopts object
66+
* Returns: (transfer full): A newly-allocated #ModulemdBuildopts object that
67+
* is a copy of @self.
6768
*
6869
* Since: 2.0
6970
*/
@@ -73,8 +74,9 @@ modulemd_buildopts_copy (ModulemdBuildopts *self);
7374

7475
/**
7576
* modulemd_buildopts_set_rpm_macros:
76-
* @self: This #ModulemdBuildopts
77-
* @rpm_macros: A string containing RPM build macros in the form that they would appear in an RPM macros file on-disk.
77+
* @self: This #ModulemdBuildopts object.
78+
* @rpm_macros: A string containing RPM build macros in the form that they
79+
* would appear in an RPM macros file on-disk.
7880
*
7981
* Since: 2.0
8082
*/
@@ -85,9 +87,10 @@ modulemd_buildopts_set_rpm_macros (ModulemdBuildopts *self,
8587

8688
/**
8789
* modulemd_buildopts_get_rpm_macros:
88-
* @self: This #ModulemdBuildopts
90+
* @self: This #ModulemdBuildopts object.
8991
*
90-
* Returns: (transfer none): A string containing RPM build macros in the form that they would appear in an RPM macros file on-disk.
92+
* Returns: (transfer none): A string containing RPM build macros in the form
93+
* that they would appear in an RPM macros file on-disk.
9194
*
9295
* Since: 2.0
9396
*/
@@ -97,7 +100,7 @@ modulemd_buildopts_get_rpm_macros (ModulemdBuildopts *self);
97100

98101
/**
99102
* modulemd_buildopts_add_rpm_to_whitelist:
100-
* @self: This #ModulemdBuildopts
103+
* @self: This #ModulemdBuildopts object.
101104
* @rpm: An RPM name to add to the whitelist.
102105
*
103106
* Since: 2.0
@@ -109,7 +112,7 @@ modulemd_buildopts_add_rpm_to_whitelist (ModulemdBuildopts *self,
109112

110113
/**
111114
* modulemd_buildopts_remove_rpm_from_whitelist:
112-
* @self: This #ModulemdBuildopts
115+
* @self: This #ModulemdBuildopts object.
113116
* @rpm: An RPM name to remove from the whitelist.
114117
*
115118
* Since: 2.0
@@ -121,7 +124,7 @@ modulemd_buildopts_remove_rpm_from_whitelist (ModulemdBuildopts *self,
121124

122125
/**
123126
* modulemd_buildopts_clear_rpm_whitelist:
124-
* @self: This #ModulemdBuildopts
127+
* @self: This #ModulemdBuildopts object.
125128
*
126129
* Remove all RPMs from the whitelist.
127130
*
@@ -133,7 +136,7 @@ modulemd_buildopts_clear_rpm_whitelist (ModulemdBuildopts *self);
133136

134137
/**
135138
* modulemd_buildopts_get_rpm_whitelist_as_strv: (rename-to modulemd_buildopts_get_rpm_whitelist)
136-
* @self: This #ModulemdBuildopts
139+
* @self: This #ModulemdBuildopts object.
137140
*
138141
* Returns: (transfer full): An ordered #GStrv list of all RPMs in the whitelist.
139142
*

‎modulemd/v2/include/modulemd-2.0/modulemd-component-module.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ modulemd_component_module_set_ref (ModulemdComponentModule *self,
6060

6161
/**
6262
* modulemd_component_module_get_ref:
63-
* @self: This #ModulemdComponentModule object
63+
* @self: This #ModulemdComponentModule object.
6464
*
6565
* Returns: (transfer none): The commit ID in the SCM repository.
6666
*
@@ -72,7 +72,7 @@ modulemd_component_module_get_ref (ModulemdComponentModule *self);
7272

7373
/**
7474
* modulemd_component_module_set_repository:
75-
* @self: This #ModulemdComponentModule object
75+
* @self: This #ModulemdComponentModule object.
7676
* @repository: (in) (nullable): The URI of the SCM repository.
7777
*
7878
* Since: 2.0
@@ -84,7 +84,7 @@ modulemd_component_module_set_repository (ModulemdComponentModule *self,
8484

8585
/**
8686
* modulemd_component_module_get_repository:
87-
* @self: This #ModulemdComponentModule object
87+
* @self: This #ModulemdComponentModule object.
8888
*
8989
* Returns: (transfer none): The URI of the SCM repository.
9090
*

‎modulemd/v2/include/modulemd-2.0/modulemd-component-rpm.h‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ modulemd_component_rpm_reset_arches (ModulemdComponentRpm *self);
7979
* modulemd_component_rpm_get_arches_as_strv: (rename-to modulemd_component_rpm_get_arches)
8080
* @self: This #ModulemdComponentRpm object.
8181
*
82-
* Returns: (transfer full): A list of architectures on which this RPM should be available.
82+
* Returns: (transfer full): A #GStrv list of architectures on which this RPM
83+
* should be available.
8384
*
8485
* Since: 2.0
8586
*/
@@ -92,7 +93,7 @@ modulemd_component_rpm_get_arches_as_strv (ModulemdComponentRpm *self);
9293
* @self: This #ModulemdComponentRpm object.
9394
* @arch: An architecture on which this package should be multilib.
9495
*
95-
* Add an architectures on which this RPM will be multilib. It may be called
96+
* Add an architecture on which this RPM will be multilib. It may be called
9697
* any number of times. Use modulemd_component_rpm_reset_multilib_arches() to
9798
* return to "no architectures".
9899
*
@@ -119,7 +120,8 @@ modulemd_component_rpm_reset_multilib_arches (ModulemdComponentRpm *self);
119120
* modulemd_component_rpm_get_multilib_arches_as_strv: (rename-to modulemd_component_rpm_get_multilib_arches)
120121
* @self: This #ModulemdComponentRpm object.
121122
*
122-
* Returns: (transfer full): A list of architectures on which multilib should be available.
123+
* Returns: (transfer full): A #GStrv list of architectures on which multilib
124+
* should be available.
123125
*
124126
* Since: 2.0
125127
*/
@@ -165,7 +167,7 @@ modulemd_component_rpm_set_ref (ModulemdComponentRpm *self, const gchar *ref);
165167

166168
/**
167169
* modulemd_component_rpm_get_ref:
168-
* @self: This #ModulemdComponentRpm object
170+
* @self: This #ModulemdComponentRpm object.
169171
*
170172
* Returns: (transfer none): The commit ID in the SCM repository.
171173
*
@@ -177,7 +179,7 @@ modulemd_component_rpm_get_ref (ModulemdComponentRpm *self);
177179

178180
/**
179181
* modulemd_component_rpm_set_repository:
180-
* @self: This #ModulemdComponentRpm object
182+
* @self: This #ModulemdComponentRpm object.
181183
* @repository: (in) (nullable): The URI of the SCM repository.
182184
*
183185
* Since: 2.0
@@ -189,7 +191,7 @@ modulemd_component_rpm_set_repository (ModulemdComponentRpm *self,
189191

190192
/**
191193
* modulemd_component_rpm_get_repository:
192-
* @self: This #ModulemdComponentRpm object
194+
* @self: This #ModulemdComponentRpm object.
193195
*
194196
* Returns: (transfer none): The URI of the SCM repository.
195197
*

‎modulemd/v2/include/modulemd-2.0/modulemd-component.h‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ struct _ModulemdComponentClass
4545

4646
/**
4747
* modulemd_component_equals:
48-
* @self_1: A #ModulemdComponent object
49-
* @self_2: A #ModulemdComponent object
48+
* @self_1: A #ModulemdComponent object.
49+
* @self_2: A #ModulemdComponent object.
5050
*
51-
* Returns: TRUE, if both the objects are equal. FALSE, otherwise
51+
* Returns: TRUE, if both the objects are equal. FALSE, otherwise.
5252
*
5353
* Since: 2.3
5454
*/
@@ -59,12 +59,12 @@ modulemd_component_equals (ModulemdComponent *self_1,
5959

6060
/**
6161
* modulemd_component_copy:
62-
* @self: This #ModulemdComponent object
62+
* @self: This #ModulemdComponent object.
6363
* @key: (in) (nullable): An optional new key for the copied component which is
6464
* used as the lookup key when this component is attached to a
6565
* #ModulemdModuleStream.
6666
*
67-
* Returns: (transfer full): A newly-allocated copy of @self
67+
* Returns: (transfer full): A newly-allocated copy of @self.
6868
*
6969
* Since: 2.0
7070
*/
@@ -74,7 +74,7 @@ modulemd_component_copy (ModulemdComponent *self, const gchar *key);
7474

7575
/**
7676
* modulemd_component_validate:
77-
* @self: (in): This #ModulemdComponent.
77+
* @self: (in): This #ModulemdComponent object.
7878
* @error: (out): A #GError that will return the reason for a validation error.
7979
*
8080
* Verifies that all stored values are internally consistent and that the
@@ -92,7 +92,7 @@ modulemd_component_validate (ModulemdComponent *self, GError **error);
9292

9393
/**
9494
* modulemd_component_add_buildafter:
95-
* @self: This #ModulemdComponent object
95+
* @self: This #ModulemdComponent object.
9696
* @key: (in): A key representing another component in the
9797
* #ModulemdModuleStream components map.
9898
*
@@ -106,7 +106,7 @@ modulemd_component_add_buildafter (ModulemdComponent *self, const gchar *key);
106106

107107
/**
108108
* modulemd_component_clear_buildafter:
109-
* @self: This #ModulemdComponent object
109+
* @self: This #ModulemdComponent object.
110110
*
111111
* Remove all buildafter entries for this component.
112112
*
@@ -118,7 +118,7 @@ modulemd_component_clear_buildafter (ModulemdComponent *self);
118118

119119
/**
120120
* modulemd_component_get_buildafter_as_strv: (rename-to modulemd_component_get_buildafter)
121-
* @self: This #ModulemdComponent object
121+
* @self: This #ModulemdComponent object.
122122
*
123123
* Returns: (transfer full): The set of component keys that this component
124124
* depends upon.
@@ -131,7 +131,7 @@ modulemd_component_get_buildafter_as_strv (ModulemdComponent *self);
131131

132132
/**
133133
* modulemd_component_set_buildonly:
134-
* @self: This #ModulemdComponent object
134+
* @self: This #ModulemdComponent object.
135135
* @buildonly: Whether this component is used only for building this module. If
136136
* set to TRUE, the build system should add any artifacts produced by this
137137
* component to the data.filters section of the output modulemd.
@@ -144,7 +144,7 @@ modulemd_component_set_buildonly (ModulemdComponent *self, gboolean buildonly);
144144

145145
/**
146146
* modulemd_component_get_buildonly:
147-
* @self: This #ModulemdComponent object
147+
* @self: This #ModulemdComponent object.
148148
*
149149
* Returns: TRUE if this component is used only for building this module.
150150
*
@@ -156,7 +156,7 @@ modulemd_component_get_buildonly (ModulemdComponent *self);
156156

157157
/**
158158
* modulemd_component_set_buildorder:
159-
* @self: This #ModulemdComponent object
159+
* @self: This #ModulemdComponent object.
160160
* @buildorder: The order this component should be built relative to others.
161161
*
162162
* Since: 2.0
@@ -167,9 +167,9 @@ modulemd_component_set_buildorder (ModulemdComponent *self, gint64 buildorder);
167167

168168
/**
169169
* modulemd_component_get_buildorder:
170-
* @self: This #ModulemdComponent object
170+
* @self: This #ModulemdComponent object.
171171
*
172-
* Returns: The value of the buildorder
172+
* Returns: The value of the buildorder.
173173
*
174174
* Since: 2.0
175175
*/
@@ -196,7 +196,7 @@ modulemd_component_set_name (ModulemdComponent *self, const gchar *name);
196196

197197
/**
198198
* modulemd_component_get_name:
199-
* @self: This #ModulemdComponent object
199+
* @self: This #ModulemdComponent object.
200200
*
201201
* Returns: (transfer none): The name of the component. Note that this may be
202202
* different from the key used to save this component to a
@@ -211,7 +211,7 @@ modulemd_component_get_name (ModulemdComponent *self);
211211

212212
/**
213213
* modulemd_component_get_key:
214-
* @self: This #ModulemdComponent object
214+
* @self: This #ModulemdComponent object.
215215
*
216216
* Returns: (transfer none): The name of the key used to attach this component
217217
* to a #ModulemdModuleStream.
@@ -224,7 +224,7 @@ modulemd_component_get_key (ModulemdComponent *self);
224224

225225
/**
226226
* modulemd_component_set_rationale:
227-
* @self: This #ModulemdComponent object
227+
* @self: This #ModulemdComponent object.
228228
* @rationale: (in) (nullable): The reason that this component is part of the
229229
* stream.
230230
*
@@ -237,7 +237,7 @@ modulemd_component_set_rationale (ModulemdComponent *self,
237237

238238
/**
239239
* modulemd_component_get_rationale:
240-
* @self: This #ModulemdComponent object
240+
* @self: This #ModulemdComponent object.
241241
*
242242
* Returns: (transfer none): The rationale.
243243
*

‎modulemd/v2/include/modulemd-2.0/modulemd-defaults-v1.h‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ modulemd_defaults_v1_get_default_stream (ModulemdDefaultsV1 *self,
8888
* separate defaults for this module, it will return the generic stream
8989
* profiles.
9090
*
91-
* Returns: (transfer full): A sorted list of unique stream names for which
92-
* default profiles have been assigned.
91+
* Returns: (transfer full): A sorted #GStrv list of unique stream names for
92+
* which default profiles have been assigned.
9393
*
9494
* Since: 2.0
9595
*/
@@ -124,8 +124,8 @@ modulemd_defaults_v1_add_default_profile_for_stream (ModulemdDefaultsV1 *self,
124124
/**
125125
* modulemd_defaults_v1_set_empty_default_profiles_for_stream:
126126
* @self: (in): This #ModulemdDefaultsV1 object.
127-
* @stream_name: (in): The name of the module stream to which to add this
128-
* default profile.
127+
* @stream_name: (in): The name of the module stream for which to empty
128+
* default profiles.
129129
* @intent: (in) (nullable): The name of the system intent from which to clear
130130
* the profile defaults for this stream.
131131
*
@@ -141,8 +141,8 @@ modulemd_defaults_v1_set_empty_default_profiles_for_stream (
141141
/**
142142
* modulemd_defaults_v1_remove_default_profiles_for_stream:
143143
* @self: (in): This #ModulemdDefaultsV1 object.
144-
* @stream_name: (in): The name of the module stream to which to add this
145-
* default profile.
144+
* @stream_name: (in): The name of the module stream from which to remove
145+
* default profiles.
146146
* @intent: (in) (nullable): The name of the system intent from which to remove
147147
* the profile defaults for this stream.
148148
*
@@ -164,9 +164,9 @@ modulemd_defaults_v1_remove_default_profiles_for_stream (
164164
* @intent: (in) (nullable): The name of the system intent from which to
165165
* retrieve the profile defaults for this stream.
166166
*
167-
* Returns: (transfer full): A sorted list of unique profiles to be installed
168-
* by default for this stream. NULL, if this stream_name is not present in the
169-
* defaults.
167+
* Returns: (transfer full): A sorted #GStrv list of unique profiles to be
168+
* installed by default for this stream. NULL, if this stream_name is not
169+
* present in the defaults.
170170
*
171171
* Since: 2.0
172172
*/

0 commit comments

Comments
 (0)