ObjFW  Check-in [365d74aa27]

Overview
Comment:Fix all Doxygen warnings.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 365d74aa27741288d8c642aabb9551eeb83c2472bf0b3995e0ff28e8ca760bc9
User & Date: js on 2013-01-10 22:52:38
Other Links: manifest | tags
Context
2013-01-11
12:13
Add -[OFMutableString appendCharacters:length:]. check-in: beb9051a10 user: js tags: trunk
2013-01-10
22:52
Fix all Doxygen warnings. check-in: 365d74aa27 user: js tags: trunk
22:52
Make sure Doxygen is not confused by some defines. check-in: 25d85f9de2 user: js tags: trunk
Changes

Modified src/OFDataArray.h from [282de3d282] to [4bd42aff32].

201
202
203
204
205
206
207
208
209

210
211

212
213
214
215
216
217
218
201
202
203
204
205
206
207

208
209
210

211
212
213
214
215
216
217
218







-

+

-
+







 */
- (void)insertItem: (const void*)item
	   atIndex: (size_t)index;

/*!
 * @brief Adds items from a C array to the OFDataArray.
 *
 * @param count The number of items to add
 * @param items A C array containing the items to add
 * @param count The number of items to add
 */
- (void)addItems: (const void*)array
- (void)addItems: (const void*)items
	   count: (size_t)count;

/*!
 * @brief Adds items from a C array to the OFDataArray at the specified index.
 *
 * @param items A C array containing the items to add
 * @param index The index where the items should be added

Modified src/OFHTTPClient.h from [4ef6dc4356] to [aa40337e14].

171
172
173
174
175
176
177

178
179
180
181
182
183
184
185
186
187
188
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189







+











 * @brief Performs the specified HTTP request
 */
- (OFHTTPRequestReply*)performRequest: (OFHTTPRequest*)request;

/*!
 * @brief Performs the HTTP request and returns an OFHTTPRequestReply.
 *
 * @param request The request which was redirected
 * @param redirects The maximum number of redirects after which no further
 *		    attempt is done to follow the redirect, but instead the
 *		    redirect is returned as an OFHTTPRequestReply
 * @return An OFHTTPRequestReply with the reply of the HTTP request
 */
- (OFHTTPRequestReply*)performRequest: (OFHTTPRequest*)request
			    redirects: (size_t)redirects;
@end

@interface OFObject (OFHTTPClientDelegate) <OFHTTPClientDelegate>
@end

Modified src/OFHTTPRequest.h from [81e77e794b] to [a0477eca6a].

115
116
117
118
119
120
121
122

123
124
125
126
127
128
129
115
116
117
118
119
120
121

122
123
124
125
126
127
128
129







-
+







- (OFDictionary*)headers;

/*!
 * @brief Sets the POST data of the HTTP request.
 *
 * @param POSTData The POST data of the HTTP request
 */
- (void)setPOSTData: (OFDataArray*)postData;
- (void)setPOSTData: (OFDataArray*)POSTData;

/*!
 * @brief Returns the POST data of the HTTP request.
 *
 * @return The POST data of the HTTP request
 */
- (OFDataArray*)POSTData;

Modified src/OFHTTPServer.h from [907886c51a] to [4cb8dc3eba].

40
41
42
43
44
45
46

47
48
49
50
51

52
53
54

55
56
57
58
59
60
61
40
41
42
43
44
45
46
47
48
49
50
51

52
53
54

55
56
57
58
59
60
61
62







+




-
+


-
+







#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
@optional
#endif
/*!
 * @brief This method is called when the HTTP server's listening socket
 *	  encountered an exception.
 *
 * @param server The HTTP server which encountered an exception
 * @param exception The exception that occurred on the HTTP server's listening
 *		    socket
 * @return Whether to continue listening. If you return NO, existing connections
 *	   will still be handled and you can start accepting new connections
 *	   again by calling @ref start again.
 *	   again by calling @ref OFHTTPServer::start again.
 */
-			  (BOOL)server: (OFHTTPServer*)server
  didReceiveExceptionOnListeningSocket: (OFException*)e;
  didReceiveExceptionOnListeningSocket: (OFException*)exception;
@end

/*!
 * @brief A class for creating a simple HTTP server inside of applications.
 */
@interface OFHTTPServer: OFObject
{

Modified src/OFStream.h from [0413580462] to [0a1063d1c6].

141
142
143
144
145
146
147
148
149
150
151




152
153
154
155
156
157
158
141
142
143
144
145
146
147




148
149
150
151
152
153
154
155
156
157
158







-
-
-
-
+
+
+
+







		     target: (id)target
		   selector: (SEL)selector;

/*!
 * @brief Asyncronously reads exactly the specified length bytes from the
 *	  stream into a buffer.
 *
 * Unlike @ref asyncReadIntoBuffer:length:block, this method does not call the
 * method when less than the specified length has been read - instead, it waits
 * until it got exactly the specified length, the stream has ended or an
 * exception occurred.
 * Unlike @ref asyncReadIntoBuffer:length:target:selector:, this method does
 * not call the method when less than the specified length has been read -
 * instead, it waits until it got exactly the specified length, the stream has
 * ended or an exception occurred.
 *
 * @param buffer The buffer into which the data is read
 * @param length The length of the data that should be read.
 *		 The buffer <i>must</i> be <i>exactly</i> this big!
 * @param target The target on which the selector should be called when the
 *		 data has been received. If the method returns YES, it will be
 *		 called again with the same buffer and exact length when more
193
194
195
196
197
198
199
200
201
202



203
204
205
206
207
208
209
193
194
195
196
197
198
199



200
201
202
203
204
205
206
207
208
209







-
-
-
+
+
+







		     length: (size_t)length
		      block: (of_stream_async_read_block_t)block;

/*!
 * @brief Asyncronously reads exactly the specified length bytes from the
 *	  stream into a buffer.
 *
 * Unlike @ref asyncReadIntoBuffer:length:block, this method does not invoke the
 * block when less than the specified length has been read - instead, it waits
 * until it got exactly the specified length, the stream has ended or an
 * Unlike @ref asyncReadIntoBuffer:length:block:, this method does not invoke
 * the block when less than the specified length has been read - instead, it
 * waits until it got exactly the specified length, the stream has ended or an
 * exception occurred.
 *
 * @param buffer The buffer into which the data is read
 * @param length The length of the data that should be read.
 *		 The buffer <i>must</i> be <i>exactly</i> this big!
 * @param block The block to call when the data has been received.
 *		If the block returns YES, it will be called again with the same
673
674
675
676
677
678
679
680

681
682
683
684
685
686
687
673
674
675
676
677
678
679

680
681
682
683
684
685
686
687







-
+







 * @return The line that was read, autoreleased, or nil if the end of the
 *	   stream has been reached.
 */
- (OFString*)tryReadTillDelimiter: (OFString*)delimiter;

/*!
 * @brief Tries to read until the specified string or \\0 is found or the end
 *	  of stream occurs (see @ref readTillDelimiterWithEncoding:) and
 *	  of stream occurs (see @ref readTillDelimiter:encoding:) and
 *	  returns nil if not enough data has been received yet.
 *
 * @param delimiter The delimiter
 * @param encoding The encoding used by the stream
 * @return The line that was read, autoreleased, or nil if the end of the
 *	   stream has been reached.
 */

Modified src/OFStreamObserver.h from [7a6891cf02] to [a69d16c5a8].

37
38
39
40
41
42
43

44
45
46
47




48
49
50
51
52
53
54
37
38
39
40
41
42
43
44




45
46
47
48
49
50
51
52
53
54
55







+
-
-
-
-
+
+
+
+







@protocol OFStreamObserverDelegate <OFObject>
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
@optional
#endif
/*!
 * @brief This callback is called when a stream did get ready for reading.
 *
 * @note When @ref OFStream::tryReadLine or
 * @note When @ref tryReadLine or @ref tryReadTillDelimiter: has been called on
 *	 the stream, this callback will not be called again until new data has
 *	 been received, even though there is still data in the cache. The reason
 *	 for this is to prevent spinning in a loop when there is an incomplete
 *	 @ref OFStream::tryReadTillDelimiter: has been called on the stream,
 *	 this callback will not be called again until new data has been
 *	 received, even though there is still data in the cache. The reason for
 *	 this is to prevent spinning in a loop when there is an incomplete
 *	 string in the cache. Once the string is complete, the callback will be
 *	 called again if there is data in the cache.
 *
 * @param stream The stream which did become ready for reading
 */
- (void)streamIsReadyForReading: (OFStream*)stream;

Modified src/OFURL.h from [98eb48b129] to [74eb4f4df2].

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
46
47
48
49
50
51
52

53
54
55
56
57
58
59







-







@property (copy) OFString *query;
@property (copy) OFString *fragment;
#endif

/*!
 * Creates a new URL.
 *
 * @param string A string describing a URL
 * @return A new, autoreleased OFURL
 */
+ (instancetype)URL;

/*!
 * Creates a new URL with the specified string.
 *

Modified src/OFXMLElement.h from [5d29eda750] to [d1aca2d059].

357
358
359
360
361
362
363
364

365
366
367
368
369
370
371
357
358
359
360
361
362
363

364
365
366
367
368
369
370
371







-
+







 */
- (void)insertChild: (OFXMLNode*)child
	    atIndex: (size_t)index;

/*!
 * @brief Inserts the specified children at the specified index.
 *
 * @param child An OFXMLNode which is added as a child
 * @param children An array of OFXMLNodes which are added as children
 * @param index The index where the child is added
 */
- (void)insertChildren: (OFArray*)children
	       atIndex: (size_t)index;

/*!
 * @brief Removes the first child that is equal to the specified OFXMLNode.