doxygen updates - include IPv6 in documentation. Exclude include/netif/ppp/polarssl.

Convert TODO -> @todo
This commit is contained in:
Dirk Ziegelmeier
2016-06-22 20:18:23 +02:00
parent cfe5182380
commit 8dc77ef558
28 changed files with 82 additions and 72 deletions

View File

@@ -727,7 +727,7 @@ int process_file(FILE *data_file, FILE *struct_file, const char *filename)
u8_t* file_data;
int is_compressed = 0;
/* create qualified name (TODO: prepend slash or not?) */
/* create qualified name (@todo: prepend slash or not?) */
sprintf(qualifiedName,"%s/%s", curSubdir, filename);
/* create C variable name */
strcpy(varname, qualifiedName);

View File

@@ -373,7 +373,7 @@ lwiperf_tx_start(lwiperf_state_tcp_t* conn)
client_conn->base.server = 0;
client_conn->server_pcb = NULL;
client_conn->conn_pcb = newpcb;
client_conn->time_started = sys_now(); /* TODO: set this again on 'connected' */
client_conn->time_started = sys_now(); /* @todo: set this again on 'connected' */
client_conn->poll_count = 0;
client_conn->next_num = 4; /* initial nr is '4' since the header has 24 byte */
client_conn->bytes_transferred = 0;
@@ -639,7 +639,7 @@ lwiperf_abort(void* lwiperf_session)
if (last != NULL) {
last->next = i;
}
LWIPERF_FREE(lwiperf_state_tcp_t, dealloc); /* TODO: type? */
LWIPERF_FREE(lwiperf_state_tcp_t, dealloc); /* @todo: type? */
} else {
last = i;
i = i->next;

View File

@@ -636,7 +636,7 @@ snmp_parse_inbound_frame(struct snmp_request *request)
u16_t u16_value;
/* SNMPv3 doesn't use communities */
/* TODO: Differentiate read/write access */
/* @todo: Differentiate read/write access */
strcpy((char*)request->community, snmp_community);
request->community_strlen = strlen(snmp_community);
@@ -723,7 +723,7 @@ snmp_parse_inbound_frame(struct snmp_request *request)
parent_tlv_value_len -= SNMP_ASN1_TLV_LENGTH(tlv);
IF_PARSE_ASSERT(parent_tlv_value_len > 0);
IF_PARSE_EXEC(snmp_asn1_dec_s32t(&pbuf_stream, tlv.value_len, &request->msg_authoritative_engine_time));
/* TODO: Implement time window checking */
/* @todo: Implement time window checking */
/* msgUserName */
IF_PARSE_EXEC(snmp_asn1_dec_tlv(&pbuf_stream, &tlv));
@@ -734,7 +734,7 @@ snmp_parse_inbound_frame(struct snmp_request *request)
IF_PARSE_EXEC(snmp_asn1_dec_raw(&pbuf_stream, tlv.value_len, request->msg_user_name,
&u16_value, SNMP_V3_MAX_USER_LENGTH));
request->msg_user_name_len = u16_value;
/* TODO: Implement unknown user error response */
/* @todo: Implement unknown user error response */
IF_PARSE_EXEC(snmpv3_get_user((char*)request->msg_user_name, NULL, NULL, NULL, NULL));
/* msgAuthenticationParameters */
@@ -769,12 +769,12 @@ snmp_parse_inbound_frame(struct snmp_request *request)
IF_PARSE_EXEC(snmpv3_get_user((char*)request->msg_user_name, &algo, key, NULL, NULL));
IF_PARSE_EXEC(snmpv3_auth(&auth_stream, request->inbound_pbuf->tot_len, key, algo, hmac));
/* TODO: Implement error response */
/* @todo: Implement error response */
IF_PARSE_EXEC(memcmp(request->msg_authentication_parameters, hmac, SNMP_V3_MAX_AUTH_PARAM_LENGTH));
}
#else
/* Ungraceful exit if we encounter cryptography and don't support it.
* TODO: Implement error response
* @todo: Implement error response
*/
IF_PARSE_ASSERT(!(request->msg_flags & (SNMP_V3_AUTH_FLAG | SNMP_V3_PRIV_FLAG)));
#endif

View File

@@ -98,7 +98,7 @@ snmpv3_get_engine_time_internal(void)
*
* Implementing RFC3826 priv param algorithm if LWIP_RAND is available.
*
* TODO: This is a potential thread safety issue.
* @todo: This is a potential thread safety issue.
*/
err_t
snmpv3_build_priv_param(u8_t* priv_param)