Skip to content

Commit c4994f2

Browse files
Fix doc comments
1 parent 0180d9c commit c4994f2

File tree

5 files changed

+19
-23
lines changed

5 files changed

+19
-23
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
dub.selections.json
44

55
# Auto-generated docs
6+
docs.json
67
docs/
78
__dummy_docs/
89

source/corefoundation/cfarray.d

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ extern CFArrayRef CFArrayCreateCopy(CFAllocatorRef allocator, CFArrayRef theArra
190190
capacity = A hint about the number of values that will be held
191191
by the CFArray. Pass 0 for no hint. The implementation may
192192
ignore this hint, or may use it to optimize various
193-
operations. An array's actual capacity is only limited by
193+
operations. (An array's actual capacity is only limited by
194194
address space and available memory constraints). If this
195195
parameter is negative, the behavior is undefined.
196196
callBacks = A pointer to a CFArrayCallBacks structure
@@ -213,7 +213,7 @@ extern CFArrayRef CFArrayCreateCopy(CFAllocatorRef allocator, CFArrayRef theArra
213213
of version 0 with all fields NULL had been passed in.
214214
Otherwise, if any of the fields are not valid pointers to
215215
functions of the correct type, or this parameter is not a
216-
valid pointer to a CFArrayCallBacks callbacks structure,
216+
valid pointer to a CFArrayCallBacks callbacks structure,
217217
the behavior is undefined. If any of the values put into the
218218
array is not one understood by one of the callback functions
219219
the behavior when that callback function is used is
@@ -236,7 +236,7 @@ extern CFMutableArrayRef CFArrayCreateMutable(CFAllocatorRef allocator, CFIndex
236236
capacity = A hint about the number of values that will be held
237237
by the CFArray. Pass 0 for no hint. The implementation may
238238
ignore this hint, or may use it to optimize various
239-
operations. An array's actual capacity is only limited by
239+
operations. (An array's actual capacity is only limited by
240240
address space and available memory constraints).
241241
This parameter must be greater than or equal
242242
to the count of the array which is to be copied, or the
@@ -465,13 +465,14 @@ extern CFIndex CFArrayGetLastIndexOfValue(CFArrayRef theArray, CFRange range, co
465465
undefined.
466466
467467
Returns:
468-
The return value is either 1) the index of a value that
469-
matched, if the target value matches one or more in the
470-
range, 2) greater than or equal to the end point of the
471-
range, if the value is greater than all the values in the
472-
range, or 3) the index of the value greater than the target
473-
value, if the value lies between two of (or less than all
474-
of) the values in the range.
468+
The return value is either
469+
1. the index of a value that matched, if the target value
470+
matches one or more in the range,
471+
2. greater than or equal to the end point of the range,
472+
if the value is greater than all the values in the range, or
473+
3. the index of the value greater than the target value,
474+
if the value lies between two of (or less than all of) the
475+
values in the range.
475476
*/
476477
extern CFIndex CFArrayBSearchValues(CFArrayRef theArray, CFRange range, const(void)* value, CFComparatorFunction comparator, void* context);
477478

source/corefoundation/cfbundle.d

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ extern CFStringRef CFBundleCopyLocalizedString(CFBundleRef bundle, CFStringRef k
164164
165165
Params:
166166
bundle = The bundle to examine.
167-
key: The key for the localized string to retrieve.
168-
value: A default value to return if no value exists for $(D key).
169-
tableName: The name of the strings file to search.
167+
key = The key for the localized string to retrieve.
168+
value = A default value to return if no value exists for $(D key).
169+
tableName = The name of the strings file to search.
170170
localizations = An array of BCP 47 language codes corresponding to available localizations.
171171
Bundle compares the array against its available localizations, and uses the best
172172
result to retrieve the localized string.

source/corefoundation/cfdictionary.d

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,6 @@ extern const __gshared CFDictionaryValueCallBacks kCFTypeDictionaryValueCallBack
151151
/**
152152
Type of the callback function used by the apply functions of
153153
CFDictionaries.
154-
155-
Params:
156-
key = The current key for the value.
157-
value = The current value from the dictionary.
158-
context = The user-defined context parameter given to the apply
159-
function.
160154
*/
161155
alias CFDictionaryApplierFunction = void function(const(void)* key, const(void)* value, void* context);
162156

@@ -291,7 +285,7 @@ extern CFDictionaryRef CFDictionaryCreateCopy(CFAllocatorRef allocator, CFDictio
291285
capacity = A hint about the number of values that will be held
292286
by the CFDictionary. Pass 0 for no hint. The implementation may
293287
ignore this hint, or may use it to optimize various
294-
operations. A dictionary's actual capacity is only limited by
288+
operations. (A dictionary's actual capacity is only limited by
295289
address space and available memory constraints). If this
296290
parameter is negative, the behavior is undefined.
297291
keyCallBacks = A pointer to a CFDictionaryKeyCallBacks structure
@@ -366,7 +360,7 @@ extern CFMutableDictionaryRef CFDictionaryCreateMutable(CFAllocatorRef allocator
366360
capacity = A hint about the number of values that will be held
367361
by the CFDictionary. Pass 0 for no hint. The implementation may
368362
ignore this hint, or may use it to optimize various
369-
operations. A dictionary's actual capacity is only limited by
363+
operations. (A dictionary's actual capacity is only limited by
370364
address space and available memory constraints).
371365
This parameter must be greater than or equal
372366
to the count of the dictionary which is to be copied, or the

source/objc/bridge.d

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To __bridge(To, From)(From from) @nogc @trusted pure {
3737
to CoreFoundation.
3838
3939
Params:
40-
A Objective-C class which can be bridge-cast to $(D To).
40+
from = A Objective-C class which can be bridge-cast to $(D To).
4141
4242
Returns:
4343
CoreFoundation object with the CF refcount increased by 1.
@@ -54,7 +54,7 @@ To __bridge_retained(To, From)(From from) @nogc @trusted pure if (is(To : NSObje
5454
to Foundation.
5555
5656
Params:
57-
A CFType which can be bridge-cast to $(D To).
57+
from = A CFType which can be bridge-cast to $(D To).
5858
5959
Returns:
6060
Foundation object with the CF refcount decreased by 1.

0 commit comments

Comments
 (0)