ObjFW  Check-in [d6b9b175b7]

Overview
Comment:More documentation improvements.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: d6b9b175b7a27f82292e09e705ee16c91045d9d23190cab8b245cf86b780c6ce
User & Date: js on 2009-08-26 19:54:43
Other Links: manifest | tags
Context
2009-08-27
17:52
Add -[removeCharactersFromIndex:toIndex:] to OFMutableString. check-in: a9ff126697 user: js tags: trunk
2009-08-26
19:54
More documentation improvements. check-in: d6b9b175b7 user: js tags: trunk
19:40
Improve documentation. check-in: 146db53e4a user: js tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Modified src/OFDataArray.h from [399b8674b6] to [2a3f92102e].

︙︙
99
100
101
102
103
104
105





106
107
108
109
110

 * Removes the specified amount of items from the end of the OFDataArray.
 *
 * \param nitems The number of items to remove
 */
- removeNItems: (size_t)nitems;
@end






@interface OFBigDataArray: OFDataArray <OFCopying>
{
	size_t size;
}
@end








>
>
>
>
>






99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

 * Removes the specified amount of items from the end of the OFDataArray.
 *
 * \param nitems The number of items to remove
 */
- removeNItems: (size_t)nitems;
@end

/**
 * The OFBigDataArray class provides a class for storing arbitrary data in an
 * array and is designed to store large hunks of data. Therefore, it allocates
 * memory in pages rather than a chunk of memory for each item.
 */
@interface OFBigDataArray: OFDataArray <OFCopying>
{
	size_t size;
}
@end

Modified src/OFHashes.h from [0d09241315] to [d2aa9374f1].

︙︙
85
86
87
88
89
90
91
92

93
94
95
96
97
98
99
100
101
102
103
104

 * \return A buffer containing the hash (SHA1_DIGEST_SIZE = 20 bytes).
 *	   The buffer is part of object's memory pool.
 */
- (uint8_t*)digest;
@end

/**
 * The OFHashing category provides methods to calculate hashes for strings.

 */
@interface OFString (OFHashing)
/**
 * \return The MD5 hash of the string as an autoreleased OFString
 */
- (OFString*)md5Hash;

/**
 * \return The SHA1 hash of the string as an autoreleased OFString
 */
- (OFString*)sha1Hash;
@end








|
>













85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

 * \return A buffer containing the hash (SHA1_DIGEST_SIZE = 20 bytes).
 *	   The buffer is part of object's memory pool.
 */
- (uint8_t*)digest;
@end

/**
 * The OFString (OFHashing) category provides methods to calculate hashes for
 * strings.
 */
@interface OFString (OFHashing)
/**
 * \return The MD5 hash of the string as an autoreleased OFString
 */
- (OFString*)md5Hash;

/**
 * \return The SHA1 hash of the string as an autoreleased OFString
 */
- (OFString*)sha1Hash;
@end

Modified src/OFIterator.h from [bde5592843] to [0fb8f20721].

︙︙
9
10
11
12
13
14
15



16

17

18

19
20
21
22
23
24
25

 * the packaging of this file.
 */

#import "OFObject.h"
#import "OFList.h"
#import "OFDictionary.h"




typedef struct __of_iterator_pair {

	id	 key;

	id	 object;

	uint32_t hash;
} of_iterator_pair_t;

extern int _OFIterator_reference;

/**
 * The OFIterator class provides methods to iterate through objects.








>
>
>

>

>

>








9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

 * the packaging of this file.
 */

#import "OFObject.h"
#import "OFList.h"
#import "OFDictionary.h"

/**
 * An iterator pair combines a key and its object in a single struct.
 */
typedef struct __of_iterator_pair {
	/// The key
	id	 key;
	/// The object for the key
	id	 object;
	/// The hash of the key
	uint32_t hash;
} of_iterator_pair_t;

extern int _OFIterator_reference;

/**
 * The OFIterator class provides methods to iterate through objects.
︙︙

Modified src/OFURLEncoding.h from [88b8d3c012] to [860a731715].

︙︙
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

 */

#import "OFMutableString.h"

extern int _OFURLEncoding_reference;

/**
 * The OFURLEncoding category provides an easy way to encode and decode strings
 * for URLs.
 */
@interface OFString (OFURLEncoding)
/**
 * Encodes a string for use in a URL.
 *
 * \return A new autoreleased string
 */








|
|








10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

 */

#import "OFMutableString.h"

extern int _OFURLEncoding_reference;

/**
 * The OFString (OFURLEncoding) category provides an easy way to encode and
 * decode strings for URLs.
 */
@interface OFString (OFURLEncoding)
/**
 * Encodes a string for use in a URL.
 *
 * \return A new autoreleased string
 */
︙︙

Modified src/OFXMLElement.h from [cc70c8e478] to [22e93175b7].

︙︙
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

 *
 * \param child Another OFXMLElement which is added as a child
 */
- addChild: (OFXMLElement*)child;
@end

/**
 * The OFXMLEscaping category provides an easy way to escape strings for use in
 * an XML document.
 */
@interface OFString (OFXMLEscaping)
/**
 * Escapes a string for use in an XML document.
 *
 * \return A new autoreleased string
 */
- stringByXMLEscaping;
@end








|
|










148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

 *
 * \param child Another OFXMLElement which is added as a child
 */
- addChild: (OFXMLElement*)child;
@end

/**
 * The OFString (OFXMLEscaping) category provides an easy way to escape strings
 * for use in an XML document.
 */
@interface OFString (OFXMLEscaping)
/**
 * Escapes a string for use in an XML document.
 *
 * \return A new autoreleased string
 */
- stringByXMLEscaping;
@end

Modified src/OFXMLParser.h from [12a6876562] to [b1406f4155].

︙︙
71
72
73
74
75
76
77




78



79







80
81
82
83
84

+ xmlParser;
- (id)delegate;
- setDelegate: (OFObject <OFXMLParserDelegate>*)delegate;
- parseBuffer: (const char*)buf
     withSize: (size_t)size;
@end





@interface OFString (OFXMLUnescaping)



- stringByXMLUnescaping;







- stringByXMLUnescapingWithHandler: (OFObject <OFXMLUnescapingDelegate>*)h;
@end

@interface OFObject (OFXMLParserDelegate) <OFXMLParserDelegate>
@end








>
>
>
>

>
>
>

>
>
>
>
>
>
>






71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

+ xmlParser;
- (id)delegate;
- setDelegate: (OFObject <OFXMLParserDelegate>*)delegate;
- parseBuffer: (const char*)buf
     withSize: (size_t)size;
@end

/**
 * The OFString (OFXMLUnescaping) category provides methods to unescape XML in
 * strings.
 */
@interface OFString (OFXMLUnescaping)
/**
 * Unescapes XML in the string.
 */
- stringByXMLUnescaping;

/**
 * Unescapes XML in the string and uses the specified handler for unknown
 * entities.
 *
 * \param h An OFXMLUnescapingDelegate as a handler for unknown entities
 */
- stringByXMLUnescapingWithHandler: (OFObject <OFXMLUnescapingDelegate>*)h;
@end

@interface OFObject (OFXMLParserDelegate) <OFXMLParserDelegate>
@end

Fossil 2.23 [47362306a7] 2023-11-01 18:56:47
This page was generated in about 0.019s