Diff: SuperTweetV1XML.cpp

Revision:

1:2d211e591fc8

Parent:

0:d48d92e6c145

Child:

2:d463d3fc4f81

--- a/SuperTweetV1XML.cpp	Tue Oct 12 22:20:38 2010 +0000
+++ b/SuperTweetV1XML.cpp	Thu Oct 28 12:02:05 2010 +0000
@@ -7,13 +7,28 @@
 
 #include "SuperTweetV1XML.h"
 
+/**
+ * Create.
+ *
+ * @param account Account name.
+ * @param password Password.
+ */
 SuperTweetV1XML::SuperTweetV1XML(const std::string account, const std::string password)
         : SuperTweet(account, password) {
 }
 
+/**
+ * Dispose.
+ */
 SuperTweetV1XML::~SuperTweetV1XML() {
 }
 
+/**
+ * Returns the 20 most recent statuses posted by the authenticating user.
+ *
+ * @param func A pointer to a callback function.
+ * @return Result code.
+ */
 HTTPResult SuperTweetV1XML::getStatusesUserTimeline(void (*func)(char *buf, size_t siz)) {
     HTTPMap map;
     HTTPStream stream;
@@ -35,6 +50,12 @@
     return result;
 }
 
+/**
+ * Returns the 20 most recent statuses, including retweets if they exist, posted by the authenticating user and the user's they follow.
+ *
+ * @param func A pointer to a callback function.
+ * @return Result code.
+ */
 HTTPResult SuperTweetV1XML::getStatusesHomeTimeline(void (*func)(char *buf, size_t siz)) {
     HTTPMap map;
     HTTPStream stream;
@@ -46,18 +67,26 @@
     stream.readNext((byte*)buf, sizeof(buf) - 1);
     HTTPResult r = client.get(url.c_str(), &stream, this, &SuperTweetV1XML::callback);
     if (r != HTTP_OK) {
-    while (!completed) {
-        Net::poll();
-        if (stream.readable()) {
-            buf[stream.readLen()] = 0;
-            func(buf, stream.readLen());
-            stream.readNext((byte*)buf, sizeof(buf) - 1);
+        while (!completed) {
+            Net::poll();
+            if (stream.readable()) {
+                buf[stream.readLen()] = 0;
+                func(buf, stream.readLen());
+                stream.readNext((byte*)buf, sizeof(buf) - 1);
+            }
         }
     }
-    }
     return result;
 }
 
+/**
+ * Updates the authenticating user's status.
+ * A status update with text identical to the authenticating user's text identical
+ * to the authenticating user's current status will be ignored to prevent duplicates.
+ *
+ * @param func A pointer to a callback function.
+ * @return Result code.
+ */
 HTTPResult SuperTweetV1XML::postStatusesUpdate(const std::string datatext, void (*func)(char *buf, size_t siz)) {
     HTTPMap map;
     HTTPStream stream;