gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-06-01 09:02:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #465 from gnustep/documentation_changes

Browse source 
Add documentation
This commit is contained in:
rfm 2024-11-17 09:56:01 +00:00 • committed by GitHub
commit cb0f6a64de
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 743 additions and 184 deletions
Download patch file Download diff file Expand all files Collapse all files

178
Headers/Foundation/NSOrderedSet.h
View file

@ -38,7 +38,7 @@
#if defined(__cplusplus) #if defined(__cplusplus)
extern "C" { extern "C" {
#endif #endif
@class GS_GENERIC_CLASS(NSArray, ElementT); @class GS_GENERIC_CLASS(NSArray, ElementT);
@class GS_GENERIC_CLASS(NSEnumerator, ElementT); @class GS_GENERIC_CLASS(NSEnumerator, ElementT);
@class GS_GENERIC_CLASS(NSSet, ElementT); @class GS_GENERIC_CLASS(NSSet, ElementT);
@ -54,83 +54,83 @@ GS_EXPORT_CLASS
// class methods // class methods
+ (instancetype) orderedSet; + (instancetype) orderedSet;
+ (instancetype) orderedSetWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)objects; + (instancetype) orderedSetWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects;
+ (instancetype) orderedSetWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)objects + (instancetype) orderedSetWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects
range: (NSRange)range range: (NSRange)range
copyItems:(BOOL)flag; copyItems: (BOOL)flag;
+ (instancetype) orderedSetWithObject:(GS_GENERIC_TYPE(ElementT))anObject; + (instancetype) orderedSetWithObject: (GS_GENERIC_TYPE(ElementT))anObject;
+ (instancetype) orderedSetWithObjects:(GS_GENERIC_TYPE(ElementT))firstObject, ...; + (instancetype) orderedSetWithObjects: (GS_GENERIC_TYPE(ElementT))firstObject, ...;
+ (instancetype) orderedSetWithObjects:(const GS_GENERIC_TYPE(ElementT)[])objects + (instancetype) orderedSetWithObjects: (const GS_GENERIC_TYPE(ElementT)[])objects
count:(NSUInteger) count; count: (NSUInteger) count;
+ (instancetype) orderedSetWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; + (instancetype) orderedSetWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet;
+ (instancetype) orderedSetWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; + (instancetype) orderedSetWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet;
+ (instancetype) orderedSetWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet + (instancetype) orderedSetWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet
copyItems:(BOOL)flag; copyItems: (BOOL)flag;
// instance methods // instance methods
- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array; - (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array;
- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array copyItems:(BOOL)flag; - (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array copyItems: (BOOL)flag;
- (instancetype) initWithArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)array - (instancetype) initWithArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)array
range:(NSRange)range range: (NSRange)range
copyItems:(BOOL)flag; copyItems: (BOOL)flag;
- (instancetype) initWithObject:(id)object; - (instancetype) initWithObject: (id)object;
- (instancetype) initWithObjects:(GS_GENERIC_TYPE(ElementT))firstObject, ...; - (instancetype) initWithObjects: (GS_GENERIC_TYPE(ElementT))firstObject, ...;
- (instancetype) initWithObjects:(const GS_GENERIC_TYPE(ElementT)[])objects - (instancetype) initWithObjects: (const GS_GENERIC_TYPE(ElementT)[])objects
count:(NSUInteger)count; count: (NSUInteger)count;
- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; - (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet;
- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet - (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet
copyItems:(BOOL)flag; copyItems: (BOOL)flag;
- (instancetype) initWithOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet - (instancetype) initWithOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet
range: (NSRange)range range: (NSRange)range
copyItems:(BOOL)flag; copyItems: (BOOL)flag;
- (instancetype) initWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; - (instancetype) initWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet;
- (instancetype) initWithSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet copyItems:(BOOL)flag; - (instancetype) initWithSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet copyItems:(BOOL)flag;
- (instancetype) init; - (instancetype) init;
- (NSUInteger) count; - (NSUInteger) count;
- (BOOL)containsObject:(GS_GENERIC_TYPE(ElementT))anObject; - (BOOL)containsObject: (GS_GENERIC_TYPE(ElementT))anObject;
- (void) enumerateObjectsAtIndexes:(NSIndexSet *)indexSet - (void) enumerateObjectsAtIndexes: (NSIndexSet *)indexSet
options:(NSEnumerationOptions)opts options: (NSEnumerationOptions)opts
usingBlock:(GSEnumeratorBlock)aBlock; usingBlock: (GSEnumeratorBlock)aBlock;
- (void) enumerateObjectsUsingBlock: (GSEnumeratorBlock)aBlock; - (void) enumerateObjectsUsingBlock: (GSEnumeratorBlock)aBlock;
- (void) enumerateObjectsWithOptions:(NSEnumerationOptions)opts - (void) enumerateObjectsWithOptions: (NSEnumerationOptions)opts
usingBlock:(GSEnumeratorBlock)aBlock; usingBlock: (GSEnumeratorBlock)aBlock;
- (GS_GENERIC_TYPE(ElementT)) firstObject; - (GS_GENERIC_TYPE(ElementT)) firstObject;
- (GS_GENERIC_TYPE(ElementT)) lastObject; - (GS_GENERIC_TYPE(ElementT)) lastObject;
- (GS_GENERIC_TYPE(ElementT)) objectAtIndex: (NSUInteger)index; - (GS_GENERIC_TYPE(ElementT)) objectAtIndex: (NSUInteger)index;
- (GS_GENERIC_TYPE(ElementT)) objectAtIndexedSubscript:(NSUInteger)index; - (GS_GENERIC_TYPE(ElementT)) objectAtIndexedSubscript: (NSUInteger)index;
- (GS_GENERIC_CLASS(NSArray, ElementT)*) objectsAtIndexes:(NSIndexSet *)indexes; - (GS_GENERIC_CLASS(NSArray, ElementT)*) objectsAtIndexes: (NSIndexSet *)indexes;
- (NSUInteger) indexOfObject:(GS_GENERIC_TYPE(ElementT))objects; - (NSUInteger) indexOfObject: (GS_GENERIC_TYPE(ElementT))objects;
- (NSUInteger) indexOfObject: (id)key - (NSUInteger) indexOfObject: (id)key
inSortedRange: (NSRange)range inSortedRange: (NSRange)range
options: (NSBinarySearchingOptions)options options: (NSBinarySearchingOptions)options
usingComparator: (NSComparator)comparator; usingComparator: (NSComparator)comparator;
- (NSUInteger) indexOfObjectAtIndexes:(NSIndexSet *)indexSet - (NSUInteger) indexOfObjectAtIndexes: (NSIndexSet *)indexSet
options:(NSEnumerationOptions)opts options: (NSEnumerationOptions)opts
passingTest:(GSPredicateBlock)predicate; passingTest: (GSPredicateBlock)predicate;
- (NSUInteger) indexOfObjectPassingTest:(GSPredicateBlock)predicate; - (NSUInteger) indexOfObjectPassingTest: (GSPredicateBlock)predicate;
- (NSUInteger) indexOfObjectWithOptions:(NSEnumerationOptions)opts - (NSUInteger) indexOfObjectWithOptions: (NSEnumerationOptions)opts
passingTest:(GSPredicateBlock)predicate; passingTest: (GSPredicateBlock)predicate;
- (NSIndexSet *) indexesOfObjectsAtIndexes:(NSIndexSet *)indexSet - (NSIndexSet *) indexesOfObjectsAtIndexes: (NSIndexSet *)indexSet
options:(NSEnumerationOptions)opts options: (NSEnumerationOptions)opts
passingTest:(GSPredicateBlock)predicate; passingTest: (GSPredicateBlock)predicate;
- (NSIndexSet *)indexesOfObjectsPassingTest:(GSPredicateBlock)predicate; - (NSIndexSet *)indexesOfObjectsPassingTest: (GSPredicateBlock)predicate;
- (NSIndexSet *) indexesOfObjectsWithOptions:(NSEnumerationOptions)opts - (NSIndexSet *) indexesOfObjectsWithOptions: (NSEnumerationOptions)opts
passingTest:(GSPredicateBlock)predicate; passingTest: (GSPredicateBlock)predicate;
- (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) objectEnumerator; - (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) objectEnumerator;
- (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) reverseObjectEnumerator; - (GS_GENERIC_CLASS(NSEnumerator, ElementT)*) reverseObjectEnumerator;
- (NSOrderedSet *)reversedOrderedSet; - (NSOrderedSet *)reversedOrderedSet;
- (void) getObjects: (__unsafe_unretained GS_GENERIC_TYPE(ElementT)[])aBuffer - (void) getObjects: (__unsafe_unretained GS_GENERIC_TYPE(ElementT)[])aBuffer
range: (NSRange)aRange; range: (NSRange)aRange;
// Key value coding support // Key value coding support
- (void) setValue: (id)value forKey: (NSString*)key; - (void) setValue: (id)value forKey: (NSString*)key;
- (id) valueForKey: (NSString*)key; - (id) valueForKey: (NSString*)key;
// Comparing Sets // Comparing Sets
- (BOOL) isEqualToOrderedSet: (NSOrderedSet *)aSet; - (BOOL) isEqualToOrderedSet: (NSOrderedSet *)aSet;
// Set operations // Set operations
- (BOOL) intersectsOrderedSet: (NSOrderedSet *)aSet; - (BOOL) intersectsOrderedSet: (NSOrderedSet *)aSet;
- (BOOL) intersectsSet: (NSSet *)aSet; - (BOOL) intersectsSet: (NSSet *)aSet;
@ -138,12 +138,12 @@ GS_EXPORT_CLASS
- (BOOL) isSubsetOfSet:(NSSet *)aSet; - (BOOL) isSubsetOfSet:(NSSet *)aSet;
// Creating a Sorted Array // Creating a Sorted Array
- (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingDescriptors:(NSArray *)sortDescriptors; - (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingDescriptors: (NSArray *)sortDescriptors;
- (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingComparator: - (GS_GENERIC_CLASS(NSArray, ElementT) *) sortedArrayUsingComparator:
(NSComparator)comparator; (NSComparator)comparator;
- (GS_GENERIC_CLASS(NSArray, ElementT) *) - (GS_GENERIC_CLASS(NSArray, ElementT) *)
sortedArrayWithOptions: (NSSortOptions)options sortedArrayWithOptions: (NSSortOptions)options
usingComparator: (NSComparator)comparator; usingComparator: (NSComparator)comparator;
// Filtering Ordered Sets // Filtering Ordered Sets
- (NSOrderedSet *)filteredOrderedSetUsingPredicate: (NSPredicate *)predicate; - (NSOrderedSet *)filteredOrderedSetUsingPredicate: (NSPredicate *)predicate;
@ -165,42 +165,42 @@ GS_EXPORT_CLASS
+ (instancetype)orderedSetWithCapacity: (NSUInteger)capacity; + (instancetype)orderedSetWithCapacity: (NSUInteger)capacity;
- (instancetype)initWithCapacity: (NSUInteger)capacity; - (instancetype)initWithCapacity: (NSUInteger)capacity;
- (instancetype) init; - (instancetype) init;
- (void)addObject:(GS_GENERIC_TYPE(ElementT))anObject; - (void)addObject: (GS_GENERIC_TYPE(ElementT))anObject;
- (void)addObjects:(const GS_GENERIC_TYPE(ElementT)[])objects count:(NSUInteger)count; - (void)addObjects: (const GS_GENERIC_TYPE(ElementT)[])objects count: (NSUInteger)count;
- (void)addObjectsFromArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; - (void)addObjectsFromArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray;
- (void)insertObject:(GS_GENERIC_TYPE(ElementT))object atIndex:(NSUInteger)index; - (void)insertObject: (GS_GENERIC_TYPE(ElementT))object atIndex: (NSUInteger)index;
- (void)setObject:(GS_GENERIC_TYPE(ElementT))object atIndexedSubscript:(NSUInteger)index; - (void)setObject: (GS_GENERIC_TYPE(ElementT))object atIndexedSubscript: (NSUInteger)index;
- (void)insertObjects:(GS_GENERIC_CLASS(NSArray, ElementT)*)array atIndexes:(NSIndexSet *)indexes; - (void)insertObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)array atIndexes: (NSIndexSet *)indexes;
- (void)removeObject:(GS_GENERIC_TYPE(ElementT))object; - (void)removeObject: (GS_GENERIC_TYPE(ElementT))object;
- (void)removeObjectAtIndex:(NSUInteger)index; - (void)removeObjectAtIndex: (NSUInteger)index;
- (void)removeObjectsAtIndexes:(NSIndexSet *)indexes; - (void)removeObjectsAtIndexes: (NSIndexSet *)indexes;
- (void)removeObjectsInArray:(GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray; - (void)removeObjectsInArray: (GS_GENERIC_CLASS(NSArray, ElementT)*)otherArray;
- (void)removeObjectsInRange:(NSRange)range; - (void)removeObjectsInRange: (NSRange)range;
- (void)removeAllObjects; - (void)removeAllObjects;
- (void)replaceObjectAtIndex:(NSUInteger)index - (void)replaceObjectAtIndex: (NSUInteger)index
withObject:(GS_GENERIC_TYPE(ElementT))object; withObject: (GS_GENERIC_TYPE(ElementT))object;
- (void) replaceObjectsAtIndexes: (NSIndexSet *)indexes - (void) replaceObjectsAtIndexes: (NSIndexSet *)indexes
withObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects; withObjects: (GS_GENERIC_CLASS(NSArray, ElementT)*)objects;
- (void) replaceObjectsInRange:(NSRange)range - (void) replaceObjectsInRange: (NSRange)range
withObjects:(const GS_GENERIC_TYPE(ElementT)[])objects withObjects: (const GS_GENERIC_TYPE(ElementT)[])objects
count: (NSUInteger)count; count: (NSUInteger)count;
- (void)setObject:(GS_GENERIC_TYPE(ElementT))object atIndex:(NSUInteger)index; - (void)setObject: (GS_GENERIC_TYPE(ElementT))object atIndex: (NSUInteger)index;
- (void)moveObjectsAtIndexes:(NSIndexSet *)indexes toIndex:(NSUInteger)index; - (void)moveObjectsAtIndexes: (NSIndexSet *)indexes toIndex: (NSUInteger)index;
- (void) exchangeObjectAtIndex:(NSUInteger)index withObjectAtIndex:(NSUInteger)otherIndex; - (void) exchangeObjectAtIndex: (NSUInteger)index withObjectAtIndex: (NSUInteger)otherIndex;
- (void)filterUsingPredicate:(NSPredicate *)predicate; - (void)filterUsingPredicate: (NSPredicate *)predicate;
- (void) sortUsingDescriptors:(NSArray *)descriptors; - (void) sortUsingDescriptors: (NSArray *)descriptors;
- (void) sortUsingComparator: (NSComparator)comparator; - (void) sortUsingComparator: (NSComparator)comparator;
- (void) sortWithOptions: (NSSortOptions)options - (void) sortWithOptions: (NSSortOptions)options
usingComparator: (NSComparator)comparator; usingComparator: (NSComparator)comparator;
- (void) sortRange: (NSRange)range - (void) sortRange: (NSRange)range
options:(NSSortOptions)options options: (NSSortOptions)options
usingComparator: (NSComparator)comparator; usingComparator: (NSComparator)comparator;
- (void) intersectOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; - (void) intersectOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet;
- (void) intersectSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; - (void) intersectSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet;
- (void) minusOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; - (void) minusOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet;
- (void) minusSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; - (void) minusSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet;
- (void) unionOrderedSet:(GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet; - (void) unionOrderedSet: (GS_GENERIC_CLASS(NSOrderedSet, ElementT)*)aSet;
- (void) unionSet:(GS_GENERIC_CLASS(NSSet, ElementT)*)aSet; - (void) unionSet: (GS_GENERIC_CLASS(NSSet, ElementT)*)aSet;
- (instancetype) initWithCoder: (NSCoder *)coder; - (instancetype) initWithCoder: (NSCoder *)coder;
@end @end

749
Headers/Foundation/NSUnit.h
View file

File diff suppressed because it is too large Load diff