# HG changeset patch # User Luke Schierer # Date 1083608019 0 # Node ID c2dff943e24024009ccb3833c057b7b054503029 # Parent 12791b1a13ee3fa11975f76853a86aa6549b32e1 [gaim-migrate @ 9634] (14:10:22) Faceprint: the timestamp plugin will now mislead users (14:10:54) Me: which way does ichat behave? (14:10:58) Me: i think the new way (14:11:05) Me: but its been some time since i've seen it (14:11:09) Faceprint: i don't know or care, the new behavior will confuse the hell out of people (14:11:22) Faceprint: lets say we have a conversation (14:11:25) Faceprint: 2:00 gets printed by the plugin (14:11:36) Faceprint: then we say nothing for 3 hours (14:11:42) Faceprint: and then one of us says something (14:12:04) Faceprint: that will be printed, and then as many as 5 minutes later, the plugin will print 5:05 (14:12:23) Me: yes yes yes, i see both sides of this one. i tend to think the new behavior is better, but i'll revert it (14:12:36) Faceprint: since "normal" timestamps are turned off, it appears as though what was just said was said around 2 (14:12:43) Faceprint: no, don't revert, fix (14:12:53) Faceprint: preferably, make the patch writer fix (14:12:57) Me: *nods* (14:13:06) Me: which requires reverting since otherwise he won't be motivated (14:13:13) Faceprint: if something is said and we've gone more than 5 min w/o printing a timestamp, print a timestamp before writing to the conv committer: Tailor Script diff -r 12791b1a13ee -r c2dff943e240 COPYRIGHT --- a/COPYRIGHT Mon May 03 18:02:21 2004 +0000 +++ b/COPYRIGHT Mon May 03 18:13:39 2004 +0000 @@ -122,7 +122,6 @@ Lex Spoon Kevin Stange David Stoddard -Robert Story Sun Microsystems Mårten (fursten) Svantesson Brian Tarricone diff -r 12791b1a13ee -r c2dff943e240 ChangeLog --- a/ChangeLog Mon May 03 18:02:21 2004 +0000 +++ b/ChangeLog Mon May 03 18:13:39 2004 +0000 @@ -21,7 +21,6 @@ the conversation window is closed, preventing a crash (Kevin Stange) * Gtk2.0 compatibility fixes (Tim Ringenbach) * Updated and standardized blist signals (Gary Kramlich) - * The timestamp plugin won't spam the conversation now (Robert Story) version 0.77 (04/22/2004): New Features: diff -r 12791b1a13ee -r c2dff943e240 plugins/timestamp.c --- a/plugins/timestamp.c Mon May 03 18:02:21 2004 +0000 +++ b/plugins/timestamp.c Mon May 03 18:13:39 2004 +0000 @@ -46,34 +46,14 @@ char *buf; char mdate[6]; time_t tim = time(NULL); - gsize len = 0; if (!g_list_find(gaim_get_conversations(), c)) return FALSE; - len = GPOINTER_TO_INT( - gaim_conversation_get_data(c, "timestamp-last-size")); - if((NULL != c->history) && (len != c->history->len)) { - - strftime(mdate, sizeof(mdate), "%02H:%02M", localtime(&tim)); - buf = g_strdup_printf("%s", mdate); - } -#ifndef DEBUG_TIMESTAMP - else { - return TRUE; - } -#else - else { - buf = g_strdup_printf("NC"); - } -#endif - - gaim_conversation_write(c, NULL, buf, GAIM_MESSAGE_NO_LOG, tim); - g_free(buf); - - gaim_conversation_set_data(c, "timestamp-last-size", - GINT_TO_POINTER(c->history->len)); - + strftime(mdate, sizeof(mdate), "%H:%M", localtime(&tim)); + buf = g_strdup_printf(" %s", mdate); + gaim_conversation_write(c, NULL, buf, GAIM_MESSAGE_NO_LOG, tim); + g_free(buf); return TRUE; } diff -r 12791b1a13ee -r c2dff943e240 src/gtksourceiter.c --- a/src/gtksourceiter.c Mon May 03 18:02:21 2004 +0000 +++ b/src/gtksourceiter.c Mon May 03 18:13:39 2004 +0000 @@ -476,12 +476,6 @@ /** * gtk_source_iter_forward_search: - * @iter: start of search - * @str: a search string - * @flags: flags affecting how the search is done - * @match_start: return location for start of match, or %NULL - * @match_end: return location for end of match, or %NULL - * @limit: bound for the search, or %NULL for the end of the buffer * * Searches forward for @str. Any match is returned by setting * @match_start to the first character of the match and @match_end to the @@ -503,8 +497,14 @@ * Same as gtk_text_iter_forward_search(), but supports case insensitive * searching. * - * Return value: whether a match was found - **/ + * @param iter start of search + * @param str a search string + * @param flags flags affecting how the search is done + * @param match_start return location for start of match, or %NULL + * @param match_end return location for end of match, or %NULL + * @param limit bound for the search, or %NULL for the end of the buffer + * @return returns whether a match was found + */ gboolean gtk_source_iter_forward_search (const GtkTextIter *iter, const gchar *str, @@ -596,18 +596,18 @@ /** * gtk_source_iter_backward_search: - * @iter: a #GtkTextIter where the search begins - * @str: search string - * @flags: bitmask of flags affecting the search - * @match_start: return location for start of match, or %NULL - * @match_end: return location for end of match, or %NULL - * @limit: location of last possible @match_start, or %NULL for start of buffer * * Same as gtk_text_iter_backward_search(), but supports case insensitive * searching. * - * Return value: whether a match was found - **/ + * @param iter a #GtkTextIter where the search begins + * @param str search string + * @param flags bitmask of flags affecting the search + * @param match_start return location for start of match, or %NULL + * @param match_end return location for end of match, or %NULL + * @param limit location of last possible @match_start, or %NULL for start of buffer + * @return returns whether a match was found + */ gboolean gtk_source_iter_backward_search (const GtkTextIter *iter, const gchar *str, diff -r 12791b1a13ee -r c2dff943e240 src/gtkutils.h --- a/src/gtkutils.h Mon May 03 18:02:21 2004 +0000 +++ b/src/gtkutils.h Mon May 03 18:13:39 2004 +0000 @@ -329,8 +329,8 @@ * Sets an ATK name for a given widget. Also sets the labelled-by * and label-for ATK relationships. * - * @w The widget that we want to name. - * @l A GtkLabel that we want to use as the ATK name for the widget. + * @param w The widget that we want to name. + * @param l A GtkLabel that we want to use as the ATK name for the widget. */ void gaim_set_accessible_label(GtkWidget *w, GtkWidget *l); diff -r 12791b1a13ee -r c2dff943e240 src/protocols/oscar/conn.c --- a/src/protocols/oscar/conn.c Mon May 03 18:02:21 2004 +0000 +++ b/src/protocols/oscar/conn.c Mon May 03 18:13:39 2004 +0000 @@ -241,10 +241,11 @@ /** * aim_conn_getnext - Gets a new connection structure. - * @sess: Session * * Allocate a new empty connection structure. * + * @param sess Session + * @return Returns new connection structure */ static aim_conn_t *aim_conn_getnext(aim_session_t *sess) { @@ -270,12 +271,12 @@ /** * aim_conn_kill - Close and free a connection. - * @sess: Session for the connection - * @deadconn: Connection to be freed * * Close, clear, and free a connection structure. Should never be * called from within libfaim. * + * @param sess Session for the connection + * @param deadconn Connection to be freed */ faim_export void aim_conn_kill(aim_session_t *sess, aim_conn_t **deadconn) { @@ -302,7 +303,6 @@ /** * aim_conn_close - Close a connection - * @deadconn: Connection to close * * Close (but not free) a connection. * @@ -310,6 +310,7 @@ * handler list and setting the fd to -1 (used to recognize * dead connections). It will also remove cookies if necessary. * + * @param deadconn Connection to close */ faim_export void aim_conn_close(aim_conn_t *deadconn) { @@ -331,15 +332,16 @@ /** * aim_getconn_type - Find a connection of a specific type - * @sess: Session to search - * @type: Type of connection to look for * * Searches for a connection of the specified type in the - * specified session. Returns the first connection of that - * type found. + * specified session. * * XXX except for RENDEZVOUS, all uses of this should be removed and * use aim_conn_findbygroup() instead. + * + * @param sess Session to search + * @param type Type of connection to look for + * @return Returns the first connection found of target type */ faim_export aim_conn_t *aim_getconn_type(aim_session_t *sess, int type) { @@ -381,10 +383,6 @@ /** * aim_proxyconnect - An extrememly quick and dirty SOCKS5 interface. - * @sess: Session to connect - * @host: Host to connect to - * @port: Port to connect to - * @statusret: Return value of the connection * * Attempts to connect to the specified host via the configured * proxy settings, if present. If no proxy is configured for @@ -392,6 +390,10 @@ * * XXX this is really awful. * + * @param sess Session to connect + * @param host Host to connect to + * @param port Port to connect to + * @param statusret Return value of the connection */ static int aim_proxyconnect(aim_session_t *sess, const char *host, fu16_t port, fu32_t *statusret) { @@ -549,16 +551,15 @@ /** * aim_cloneconn - clone an aim_conn_t - * @sess: session containing parent - * @src: connection to clone * * A new connection is allocated, and the values are filled in * appropriately. Note that this function sets the new connnection's * ->priv pointer to be equal to that of its parent: only the pointer * is copied, not the data it points to. * - * This function returns a pointer to the new aim_conn_t, or %NULL on - * error + * @param sess session containing parent + * @param src connection to clone + * @return Returns a pointer to the new aim_conn_t, or %NULL on error */ faim_internal aim_conn_t *aim_cloneconn(aim_session_t *sess, aim_conn_t *src) { @@ -593,9 +594,6 @@ /** * aim_newconn - Open a new connection - * @sess: Session to create connection in - * @type: Type of connection to create - * @dest: Host to connect to (in "host:port" syntax) * * Opens a new connection to the specified dest host of specified * type, using the proxy settings if available. If @host is %NULL, @@ -604,6 +602,9 @@ * * FIXME: Return errors in a more sane way. * + * @param sess Session to create connection in + * @param type Type of connection to create + * @param dest Host to connect to (in "host:port" syntax) */ faim_export aim_conn_t *aim_newconn(aim_session_t *sess, int type, const char *dest) { @@ -659,11 +660,10 @@ /** * aim_conngetmaxfd - Return the highest valued file discriptor in session - * @sess: Session to search * - * Returns the highest valued filed descriptor of all open - * connections in @sess. - * + * @param sess Session to search + * @return Returns the highest values file descriptor of + * all open connections in @sess */ faim_export int aim_conngetmaxfd(aim_session_t *sess) { @@ -679,13 +679,13 @@ } /** - * aim_conn_in_sess - Predicate to test the precense of a connection in a sess - * @sess: Session to look in - * @conn: Connection to look for + * aim_conn_in_sess - Predicate to test the presense of a connection in a sess + * + * Searches @sess for the passed connection. * - * Searches @sess for the passed connection. Returns 1 if its present, - * zero otherwise. - * + * @param sess Session to look in + * @param conn Connection to look for + * @return Returns 1 if the passed connection is present, zero otherwise */ faim_export int aim_conn_in_sess(aim_session_t *sess, aim_conn_t *conn) { @@ -701,9 +701,6 @@ /** * aim_select - Wait for a socket with data or timeout - * @sess: Session to wait on - * @timeout: How long to wait - * @status: Return status * * Waits for a socket with data or for timeout, whichever comes first. * See select(2). @@ -714,6 +711,10 @@ * 1 outgoing data pending (%NULL returned) * 2 incoming data pending (connection with pending data returned) * + * @param sess Session to wait on + * @param timeout How long to wait + * @param status Return status + * @return If @status is 2, returns connection with pending data, otherwise %NULL */ faim_export aim_conn_t *aim_select(aim_session_t *sess, struct timeval *timeout, int *status) { @@ -783,8 +784,6 @@ /** * aim_conn_setlatency - Set a forced latency value for connection - * @conn: Conn to set latency for - * @newval: Number of seconds to force between transmits * * Causes @newval seconds to be spent between transmits on a connection. * @@ -794,6 +793,9 @@ * XXX: This should really be replaced with something that scales and * backs off like the real rate limiting does. * + * @param conn Conn to set latency for + * @param newval Number of seconds to force between transmits + * @return Returns -1 if the connection does not exist, zero otherwise */ faim_export int aim_conn_setlatency(aim_conn_t *conn, int newval) { @@ -809,10 +811,6 @@ /** * aim_setupproxy - Configure a proxy for this session - * @sess: Session to set proxy for - * @server: SOCKS server - * @username: SOCKS username - * @password: SOCKS password * * Call this with your SOCKS5 proxy server parameters before * the first call to aim_newconn(). If called with all %NULL @@ -820,6 +818,10 @@ * * Set username and password to %NULL if not applicable. * + * @param sess Session to set proxy for + * @param server SOCKS server + * @param username SOCKS username + * @param password SOCKS password */ faim_export void aim_setupproxy(aim_session_t *sess, const char *server, const char *username, const char *password) { @@ -929,8 +931,8 @@ /** * aim_session_kill - Deallocate a session - * @sess: Session to kill * + * @param sess Session to kill */ faim_export void aim_session_kill(aim_session_t *sess) { @@ -945,13 +947,14 @@ /** * aim_setdebuggingcb - Set the function to call when outputting debugging info - * @sess: Session to change - * @cb: Function to call * * The function specified is called whenever faimdprintf() is used within * libfaim, and the session's debugging level is greater tha nor equal to * the value faimdprintf was called with. * + * @param sess Session to change + * @param cb Function to call + * @return Returns -1 if the session does not exist, zero otherwise */ faim_export int aim_setdebuggingcb(aim_session_t *sess, faim_debugging_callback_t cb) { @@ -966,12 +969,11 @@ /** * aim_conn_isconnecting - Determine if a connection is connecting - * @conn: Connection to examine * - * Returns nonzero if the connection is in the process of - * connecting (or if it just completed and aim_conn_completeconnect() - * has yet to be called on it). - * + * @param conn Connection to examine + * @return Returns nonzero if the connection is in the process of + * connecting (or if it just completed and + * aim_conn_completeconnect() has yet to be called on it). */ faim_export int aim_conn_isconnecting(aim_conn_t *conn) { diff -r 12791b1a13ee -r c2dff943e240 src/protocols/oscar/msgcookie.c --- a/src/protocols/oscar/msgcookie.c Mon May 03 18:02:21 2004 +0000 +++ b/src/protocols/oscar/msgcookie.c Mon May 03 18:13:39 2004 +0000 @@ -16,16 +16,15 @@ /** * aim_cachecookie - appends a cookie to the cookie list - * @sess: session to add to - * @cookie: pointer to struct to append * * if cookie->cookie for type cookie->type is found, updates the * ->addtime of the found structure; otherwise adds the given cookie * to the cache * - * returns -1 on error, 0 on append, 1 on update. the cookie you pass - * in may be free'd, so don't count on its value after calling this! - * + * @param sess session to add to + * @param cookie pointer to struct to append + * @return returns -1 on error, 0 on append, 1 on update. the cookie you pass + * in may be free'd, so don't count on its value after calling this! */ faim_internal int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie) { @@ -52,13 +51,13 @@ /** * aim_uncachecookie - grabs a cookie from the cookie cache (removes it from the list) - * @sess: session to grab cookie from - * @cookie: cookie string to look for - * @type: cookie type to look for * * takes a cookie string and a cookie type and finds the cookie struct associated with that duple, removing it from the cookie list ikn the process. * - * if found, returns the struct; if none found (or on error), returns NULL: + * @param sess session to grab cookie from + * @param cookie cookie string to look for + * @param type cookie type to look for + * @return if found, returns the struct; if none found (or on error), returns NULL: */ faim_internal aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, fu8_t *cookie, int type) { @@ -81,13 +80,12 @@ /** * aim_mkcookie - generate an aim_msgcookie_t *struct from a cookie string, a type, and a data pointer. - * @c: pointer to the cookie string array - * @type: cookie type to use - * @data: data to be cached with the cookie * - * returns NULL on error, a pointer to the newly-allocated cookie on - * success. - * + * @param c pointer to the cookie string array + * @param type cookie type to use + * @param data data to be cached with the cookie + * @return returns NULL on error, a pointer to the newly-allocated + * cookie on success. */ faim_internal aim_msgcookie_t *aim_mkcookie(fu8_t *c, int type, void *data) { @@ -108,13 +106,12 @@ /** * aim_checkcookie - check to see if a cookietuple has been cached - * @sess: session to check for the cookie in - * @cookie: pointer to the cookie string array - * @type: type of the cookie to look for * - * this returns a pointer to the cookie struct (still in the list) on - * success; returns NULL on error/not found - * + * @param sess session to check for the cookie in + * @param cookie pointer to the cookie string array + * @param type type of the cookie to look for + * @return returns a pointer to the cookie struct (still in the list) + * on success; returns NULL on error/not found */ faim_internal aim_msgcookie_t *aim_checkcookie(aim_session_t *sess, const fu8_t *cookie, int type) @@ -146,15 +143,15 @@ /** * aim_cookie_free - free an aim_msgcookie_t struct - * @sess: session to remove the cookie from - * @cookiep: the address of a pointer to the cookie struct to remove * * this function removes the cookie *cookie from teh list of cookies * in sess, and then frees all memory associated with it. including * its data! if you want to use the private data after calling this, * make sure you copy it first. * - * returns -1 on error, 0 on success. + * @param sess session to remove the cookie from + * @param cookie the address of a pointer to the cookie struct to remove + * @return returns -1 on error, 0 on success. * */ faim_internal int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie) diff -r 12791b1a13ee -r c2dff943e240 src/roomlist.h --- a/src/roomlist.h Mon May 03 18:02:21 2004 +0000 +++ b/src/roomlist.h Mon May 03 18:13:39 2004 +0000 @@ -179,7 +179,7 @@ * whether or not we're busy downloading a room list or not. * * @param list The room list. - * @returns True if we're downloading it, or false if we're not. + * @return True if we're downloading it, or false if we're not. */ gboolean gaim_roomlist_get_in_progress(GaimRoomlist *list);