Dear Wiki user, You have subscribed to a wiki page or wiki category on "Ws Wiki" for change notification.
The following page has been changed by senaka: http://wiki.apache.org/ws/FrontPage/Axis2C/apidocs ------------------------------------------------------------------------------ ==== Methods ==== - TODO: need to agree on a convention. + Documenting of methods is quite an easy task, which is mostly forgotten by many developers. You will have to add a brief description, followed by documentation of formal parameters using the '''''@param''''' directive, and finally documenting the return value using the '''''@return''''' directive. + + {{{ + /** + * <desciption> + * @param <param_name> <desciption> + * @param <param_name> <desciption> + . + . + . + + * @return <description> + */ + }}} + + Please make sure to document parameters in the order that they appear. + + Ex:- + + {{{ + /** + * Sets a property with the given key. + * @param ctx pointer to context struct + * @param env pointer to environment struct + * @param key key string to store the property with + * @param value pointer to property to be stored, context assumes the + * ownership of the property + * @param persistent persist ency status, AXIS2_TRUE if the value is to + * be stored in the resistant store, AXIS2_FALSE if it is to be stored + * in the non-persistent store + * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE + */ + AXIS2_EXTERN axis2_status_t AXIS2_CALL + axis2_ctx_set_property( + struct axis2_ctx *ctx, + const axutil_env_t * env, + const axis2_char_t * key, + axutil_property_t * value); + }}} + + ===== Common Mistakes to be avoided ===== + + 1. Using @returns instead of @return + 1. Documenting params in wrong order + 1. Misspelling or not including param name + 1. Forgetting to document params + 1. Unwanted parameters (due to a careless copy-paste) ==== Global Variables ==== @@ -105, +151 @@ ==== include ==== + ||<:50%>'''Name'''||<:20%>'''Name of assignee'''||<:15%>'''Completed'''||<:15%>'''Has Module Def'''|| + ||axis2_msg_ctx.h||Senaka||No||No|| + ==== axiom/include ==== ==== guththila/include ==== --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
