wrong comments in nonos_sdk

[mmmmar]

in espconn.h

Code: Select all

/******************************************************************************
 * FunctionName : espconn_port
 * Description  : access port value for client so that we don't end up bouncing
 *                all connections at the same time .
 * Parameters   : none
 * Returns      : access port value
*******************************************************************************/

uint32 espconn_port(void);

/******************************************************************************
 * FunctionName : espconn_set_opt
 * Description  : access port value for client so that we don't end up bouncing
 *                all connections at the same time .
 * Parameters   : none
 * Returns      : access port value
*******************************************************************************/

sint8 espconn_set_opt(struct espconn *espconn, uint8 opt);

Obviously there are mistakes in comments.

in at_custom.h

Code: Select all

/**
  * @brief  get string form at cmd line.the maybe alter pSrc
  * @param  p_dest: the buffer to be placed result
  *         p_src: at cmd line string
  *         max_len :max len of string excepted to get
  * @retval None
  */
int32 at_data_str_copy(char *p_dest, char **p_src, int32 max_len);

In SDK_API_Reference, this function returns length of string


hope to change.

[pratik]

Thanks for the feedback, I have noticed some as well. Someone probably forgot to edit comments after copy-pasting the comment template.
We will roll the edits into the next release.