ObjFW  Check-in [bf836060fb]

Overview
Comment:Documentation improvements.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: bf836060fb203b5a51751d33eee47a86f890d8c1081a9f24d052454c56103a1e
User & Date: js on 2010-12-20 15:12:06
Other Links: manifest | tags
Context
2010-12-20
15:51
OFXMLParser: Allow comments after the document root. check-in: f40092db22 user: js tags: trunk
15:12
Documentation improvements. check-in: bf836060fb user: js tags: trunk
2010-12-18
23:39
Add support for the new GNU runtime. check-in: 6f4eb004a3 user: js tags: trunk
Changes

Modified src/OFArray.h from [eb78f84a2f] to [346c4b0ea9].

132
133
134
135
136
137
138
139

140
141
142

143
144
145
146
147
148

149
150
151
152

153
154
155
156
157
158
159
132
133
134
135
136
137
138

139
140
141
142
143
144
145
146
147
148

149
150
151
152

153
154
155
156
157
158
159
160







-
+



+





-
+



-
+







 * \param index The number of the object to return
 * \return The specified object of the OFArray
 */
- (id)objectAtIndex: (size_t)index;

/**
 * Returns the index of the first object that is equivalent to the specified
 * object.
 * object or SIZE_MAX if it was not found.
 *
 * \param obj The object whose index is returned
 * \return The index of the first object equivalent to the specified object
 * 	   or SIZE_MAX if it was not found
 */
- (size_t)indexOfObject: (id)obj;

/**
 * Returns the index of the first object that has the same address as the
 * specified object.
 * specified object or SIZE_MAX if it was not found.
 *
 * \param obj The object whose index is returned
 * \return The index of the first object that has the same aaddress as
 *	   the specified object
 *	   the specified object or SIZE_MAX if it was not found
 */
- (size_t)indexOfObjectIdenticalTo: (id)obj;

/**
 * Returns the first object of the array or nil.
 *
 * The returned object is <i>not</i> retained and autoreleased for performance

Modified src/OFExceptions.h from [501618be41] to [cf0e8b7f35].

1153
1154
1155
1156
1157
1158
1159
1160

1161
1162
1163
1164
1165
1166
1167
1153
1154
1155
1156
1157
1158
1159

1160
1161
1162
1163
1164
1165
1166
1167







-
+







@interface OFUnboundNamespaceException: OFException
{
	OFString *ns;
	OFString *prefix;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, nonatomic, getter=namespace) OFString *ns;
@property (readonly, nonatomic) OFString *namespace;
@property (readonly, nonatomic) OFString *prefix;
#endif

/**
 * \param class_ The class of the object which caused the exception
 * \param ns The namespace which is unbound
 * \return A new unbound namespace exception

Modified src/OFString.h from [43d907f36d] to [425969f6b0].

286
287
288
289
290
291
292
293

294
295
296
297
298
299
300

301
302
303
304
305
306
307
286
287
288
289
290
291
292

293
294
295
296
297
298
299

300
301
302
303
304
305
306
307







-
+






-
+







 * \return The Unicode character at the specified index
 */
- (of_unichar_t)characterAtIndex: (size_t)index;

/**
 * \param str The string to search
 * \return The index of the first occurrence of the string or SIZE_MAX if it
 *	   wasn't found
 *	   was not found
 */
- (size_t)indexOfFirstOccurrenceOfString: (OFString*)str;

/**
 * \param str The string to search
 * \return The index of the last occurrence of the string or SIZE_MAX if it
 *	   wasn't found
 *	   was not found
 */
- (size_t)indexOfLastOccurrenceOfString: (OFString*)str;

/**
 * \param start The index where the substring starts
 * \param end The index where the substring ends.
 *	      This points BEHIND the last character!

Modified src/OFXMLAttribute.h from [ece2229692] to [20b872cf08].

22
23
24
25
26
27
28
29

30
31
32
33
34
35
36
22
23
24
25
26
27
28

29
30
31
32
33
34
35
36







-
+







	OFString *name;
	OFString *ns;
	OFString *stringValue;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, retain) OFString *name;
@property (readonly, retain, getter=namespace) OFString *ns;
@property (readonly, retain) OFString *namespace;
@property (readonly, retain) OFString *stringValue;
#endif

/**
 * \param name The name of the attribute
 * \param ns The namespace of the attribute
 * \param value The string value of the attribute

Modified src/OFXMLElement.h from [ee4c57317a] to [9e27a7cf05].

32
33
34
35
36
37
38
39

40
41
42
43
44
45
46
32
33
34
35
36
37
38

39
40
41
42
43
44
45
46







-
+







	OFString *characters;
	OFString *cdata;
	OFMutableString *comment;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, copy) OFString *name;
@property (readonly, copy, getter=namespace) OFString *ns;
@property (readonly, copy) OFString *namespace;
@property (copy) OFString *defaultNamespace;
@property (readonly, copy) OFArray *attributes;
@property (readonly, copy) OFArray *children;
#endif

/**
 * \param name The name for the element