From: jongfoster Date: Sun, 12 May 2002 21:36:29 +0000 (+0000) Subject: Correcting function comments X-Git-Tag: v_3_0_branchpoint~90 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=d3b49edb39bfc457d4c9047b01e1dbcdd3cf209e Correcting function comments --- diff --git a/actions.c b/actions.c index aa1d0264..4b31f7fe 100644 --- a/actions.c +++ b/actions.c @@ -1,4 +1,4 @@ -const char actions_rcs[] = "$Id: actions.c,v 1.30 2002/04/30 11:14:52 oes Exp $"; +const char actions_rcs[] = "$Id: actions.c,v 1.31 2002/05/06 07:56:50 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/actions.c,v $ @@ -33,6 +33,9 @@ const char actions_rcs[] = "$Id: actions.c,v 1.30 2002/04/30 11:14:52 oes Exp $" * * Revisions : * $Log: actions.c,v $ + * Revision 1.31 2002/05/06 07:56:50 oes + * Made actions_to_html independent of FEATURE_CGI_EDIT_ACTIONS + * * Revision 1.30 2002/04/30 11:14:52 oes * Made csp the first parameter in *action_to_html * @@ -262,11 +265,11 @@ static int load_one_actions_file(struct client_state *csp, int fileid); * Function : merge_actions * * Description : Merge two actions together. - * Similar to "cur_action += new_action". + * Similar to "dest += src". * * Parameters : - * 1 : cur_action = Current actions, to modify. - * 2 : new_action = Action to add. + * 1 : dest = Actions to modify. + * 2 : src = Action to add. * * Returns : JB_ERR_OK or JB_ERR_MEMORY * @@ -337,7 +340,7 @@ jb_err merge_actions (struct action_spec *dest, * Function : copy_action * * Description : Copy an action_specs. - * Similar to "cur_action = new_action". + * Similar to "dest = src". * * Parameters : * 1 : dest = Destination of copy. @@ -543,7 +546,7 @@ jb_err get_action_token(char **line, char **name, char **value) * Parameters : * 1 : line = The string containing the actions. * Will be written to by this function. - * 2 : aliases = Custom alias list, or NULL for none. + * 2 : alias_list = Custom alias list, or NULL for none. * 3 : cur_action = Where to store the action. Caller * allocates memory. * @@ -1378,13 +1381,12 @@ static int load_one_actions_file(struct client_state *csp, int fileid) * * Function : actions_to_text * - * Description : Converts a actionsfile entry from numeric form - * ("mask" and "add") to a text line which is split + * Description : Converts a actionsfile entry from the internal + * structurt into a text line. The output is split * into one line for each action with line continuation. * * Parameters : - * 1 : mask = As from struct url_actions - * 2 : add = As from struct url_actions + * 1 : action = The action to format. * * Returns : A string. Caller must free it. * NULL on out-of-memory error. diff --git a/cgi.c b/cgi.c index 6352b592..2ff7e605 100644 --- a/cgi.c +++ b/cgi.c @@ -1,4 +1,4 @@ -const char cgi_rcs[] = "$Id: cgi.c,v 1.66 2002/04/26 18:32:57 jongfoster Exp $"; +const char cgi_rcs[] = "$Id: cgi.c,v 1.67 2002/04/30 12:02:07 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/cgi.c,v $ @@ -38,6 +38,9 @@ const char cgi_rcs[] = "$Id: cgi.c,v 1.66 2002/04/26 18:32:57 jongfoster Exp $"; * * Revisions : * $Log: cgi.c,v $ + * Revision 1.67 2002/04/30 12:02:07 oes + * Nit: updated a comment + * * Revision 1.66 2002/04/26 18:32:57 jongfoster * Fixing a memory leak on error * @@ -754,7 +757,7 @@ static struct http_response *dispatch_known_cgi(struct client_state * csp, * pairs and store them in a struct map list. * * Parameters : - * 1 : string = string to be parsed. Will be trashed. + * 1 : argstring = string to be parsed. Will be trashed. * * Returns : pointer to param list, or NULL if out of memory. * @@ -1105,14 +1108,10 @@ void cgi_init_error_messages(void) * Description : Called if a CGI function runs out of memory. * Returns a statically-allocated error response. * - * Parameters : - * 1 : csp = Current client state (buffers, headers, etc...) - * 2 : rsp = http_response data structure for output - * 3 : template_name = Name of template that could not - * be loaded. + * Parameters : N/A * - * Returns : JB_ERR_OK on success - * JB_ERR_MEMORY on out-of-memory error. + * Returns : http_response data structure for output. This is + * statically allocated, for obvious reasons. * *********************************************************************/ struct http_response *cgi_error_memory(void) @@ -1249,6 +1248,7 @@ jb_err cgi_error_bad_param(struct client_state *csp, * Parameters : * 1 : item = item (will NOT be free()d.) * It is assumed to be HTML-safe. + * 2 : config = The current configuration. * * Returns : String with item embedded in link, or NULL on * out-of-memory @@ -1505,7 +1505,7 @@ void free_http_response(struct http_response *rsp) * 1 : csp = Current client state (buffers, headers, etc...) * 2 : template_ptr = Destination for pointer to loaded * template text. - * 3 : template = name of the HTML template to be used + * 3 : templatename = name of the HTML template to be used * 4 : recursive = Flag set if this function calls itself * following an #include statament * @@ -1752,6 +1752,7 @@ jb_err template_fill(char **template_ptr, const struct map *exports) * 2 : templatename = name of the HTML template to be used * 3 : exports = map with fill in symbol -> name pairs. * Will be freed by this function. + * 4 : rsp = Response structure to fill in. * * Returns : JB_ERR_OK on success * JB_ERR_MEMORY on out-of-memory error diff --git a/deanimate.c b/deanimate.c index 94311d48..59ed56e9 100644 --- a/deanimate.c +++ b/deanimate.c @@ -1,4 +1,4 @@ -const char deanimate_rcs[] = "$Id: deanimate.c,v 1.10 2002/03/24 13:25:43 swa Exp $"; +const char deanimate_rcs[] = "$Id: deanimate.c,v 1.11 2002/03/26 22:29:54 swa Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/deanimate.c,v $ @@ -37,6 +37,9 @@ const char deanimate_rcs[] = "$Id: deanimate.c,v 1.10 2002/03/24 13:25:43 swa Ex * * Revisions : * $Log: deanimate.c,v $ + * Revision 1.11 2002/03/26 22:29:54 swa + * we have a new homepage! + * * Revision 1.10 2002/03/24 13:25:43 swa * name change related issues * @@ -207,7 +210,7 @@ int buf_copy(struct binbuffer *src, struct binbuffer *dst, size_t length) * given offset * * Parameters : - * 1 : buf = Pointer to the source binbuffer + * 1 : src = Pointer to the source binbuffer * 2 : offset = Offset to the desired byte * * Returns : The byte on success, or 0 on failiure diff --git a/gateway.c b/gateway.c index cff71726..7584b945 100644 --- a/gateway.c +++ b/gateway.c @@ -1,4 +1,4 @@ -const char gateway_rcs[] = "$Id: gateway.c,v 1.14 2002/03/24 13:25:43 swa Exp $"; +const char gateway_rcs[] = "$Id: gateway.c,v 1.15 2002/03/26 22:29:54 swa Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/gateway.c,v $ @@ -34,6 +34,9 @@ const char gateway_rcs[] = "$Id: gateway.c,v 1.14 2002/03/24 13:25:43 swa Exp $" * * Revisions : * $Log: gateway.c,v $ + * Revision 1.15 2002/03/26 22:29:54 swa + * we have a new homepage! + * * Revision 1.14 2002/03/24 13:25:43 swa * name change related issues * @@ -186,11 +189,11 @@ static const char socks_userid[] = "anonymous"; * a HTTP proxy and/or a SOCKS proxy. * * Parameters : - * 1 : gw = pointer to a gateway structure (such as gw_default) + * 1 : fwd = the proxies to use when connecting. * 2 : http = the http request and apropos headers * 3 : csp = Current client state (buffers, headers, etc...) * - * Returns : -1 => failure, else it is the socket file descriptor. + * Returns : JB_INVALID_SOCKET => failure, else it is the socket file descriptor. * *********************************************************************/ jb_socket forwarded_connect(const struct forward_spec * fwd, @@ -244,11 +247,12 @@ jb_socket forwarded_connect(const struct forward_spec * fwd, * normal (non-SOCKS) socket. * * Parameters : - * 1 : gw = pointer to a gateway structure (such as gw_default) - * 2 : http = the http request and apropos headers - * 3 : csp = Current client state (buffers, headers, etc...) + * 1 : fwd = Specifies the SOCKS proxy to use. + * 2 : target_host = The final server to connect to. + * 3 : target_port = The final port to connect to. + * 4 : csp = Current client state (buffers, headers, etc...) * - * Returns : -1 => failure, else a socket file descriptor. + * Returns : JB_INVALID_SOCKET => failure, else a socket file descriptor. * *********************************************************************/ static jb_socket socks4_connect(const struct forward_spec * fwd, diff --git a/loadcfg.c b/loadcfg.c index d62244cb..451ba641 100644 --- a/loadcfg.c +++ b/loadcfg.c @@ -1,4 +1,4 @@ -const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.45 2002/04/24 02:11:54 oes Exp $"; +const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.46 2002/04/26 12:55:14 oes Exp $"; /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/loadcfg.c,v $ @@ -35,6 +35,11 @@ const char loadcfg_rcs[] = "$Id: loadcfg.c,v 1.45 2002/04/24 02:11:54 oes Exp $" * * Revisions : * $Log: loadcfg.c,v $ + * Revision 1.46 2002/04/26 12:55:14 oes + * - New option "user-manual", defaults to our site + * via project.h #define + * - savearg now embeds option names in help links + * * Revision 1.45 2002/04/24 02:11:54 oes * Jon's multiple AF patch: Allow up to MAX_ACTION_FILES actionsfile options * @@ -530,11 +535,9 @@ void unload_current_config_file(void) * * Description : Load the config file and all parameters. * - * Parameters : - * 1 : csp = Client state (the config member will be - * filled in by this function). + * Parameters : None * - * Returns : 0 => Ok, everything else is an error. + * Returns : The configuration_spec, or NULL on error. * *********************************************************************/ struct configuration_spec * load_config(void) @@ -1520,6 +1523,7 @@ struct configuration_spec * load_config(void) * Parameters : * 1 : command = config setting that was found * 2 : argument = the setting's argument (if any) + * 3 : config = Configuration to save into. * * Returns : N/A *