abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-08-10 17:43:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix several doxygen errors all over the code

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2016-05-23 21:18:16 +02:00
parent f4bf0dff85
commit 90a656ed78
9 changed files with 39 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/apps/snmp/snmp_asn1.c
View File

@@ -628,10 +628,11 @@ snmp_asn1_dec_s32t(struct snmp_pbuf_stream *pbuf_stream, u16_t len, s32_t *value
/**
* Decodes object identifier from incoming message into array of u32_t.
*
* @param p points to a pbuf holding an ASN1 coded object identifier
* @param ofs points to the offset within the pbuf chain of the ASN1 coded object identifier
* @param pbuf_stream points to a pbuf stream
* @param len length of the coded object identifier
* @param oid return object identifier struct
* @param oid return decoded object identifier
* @param oid_len return decoded object identifier length
* @param oid_max_len size of oid buffer
* @return ERR_OK if successful, ERR_ARG if we can't (or won't) decode
*/
err_t
@@ -718,11 +719,11 @@ snmp_asn1_dec_oid(struct snmp_pbuf_stream *pbuf_stream, u16_t len, u32_t* oid, u
* Decodes (copies) raw data (ip-addresses, octet strings, opaque encoding)
* from incoming message into array.
*
* @param p points to a pbuf holding an ASN1 coded raw data
* @param ofs points to the offset within the pbuf chain of the ASN1 coded raw data
* @param pbuf_stream points to a pbuf stream
* @param len length of the coded raw data (zero is valid, e.g. empty string!)
* @param raw_len length of the raw return value
* @param raw return raw bytes
* @param buf return raw bytes
* @param buf_len returns length of the raw return value
* @param buf_max_len buffer size
* @return ERR_OK if successful, ERR_ARG if we can't (or won't) decode
*/
err_t

2
src/apps/snmp/snmp_core.c
View File

@@ -106,7 +106,7 @@ const struct snmp_obj_id* snmp_get_device_enterprise_oid(void)
#if LWIP_IPV4
/**
* Conversion from InetAddressIPv4 oid to lwIP ip4_addr
* @param ident points to u32_t ident[4] input
* @param oid points to u32_t ident[4] input
* @param ip points to output struct
*/
u8_t

10
src/apps/sntp/sntp.c
View File

@@ -15,7 +15,7 @@
*/
/*
* Copyright (c) 2007-2009 Frédéric Bernon, Simon Goldschmidt
* Copyright (c) 2007-2009 Fr<EFBFBD>d<EFBFBD>ric Bernon, Simon Goldschmidt
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
@@ -42,7 +42,7 @@
*
* This file is part of the lwIP TCP/IP stack.
*
* Author: Frédéric Bernon, Simon Goldschmidt
* Author: Fr<EFBFBD>d<EFBFBD>ric Bernon, Simon Goldschmidt
*/
#include "lwip/apps/sntp.h"
@@ -618,8 +618,8 @@ sntp_servermode_dhcp(int set_servers_from_dhcp)
/**
* Initialize one of the NTP servers by IP address
*
* @param numdns the index of the NTP server to set must be < SNTP_MAX_SERVERS
* @param dnsserver IP address of the NTP server to set
* @param idx the index of the NTP server to set must be < SNTP_MAX_SERVERS
* @param server IP address of the NTP server to set
*/
void
sntp_setserver(u8_t idx, const ip_addr_t *server)
@@ -666,7 +666,7 @@ dhcp_set_ntp_servers(u8_t num, const ip4_addr_t *server)
/**
* Obtain one of the currently configured by IP address (or DHCP) NTP servers
*
* @param numdns the index of the NTP server
* @param idx the index of the NTP server
* @return IP address of the indexed NTP server or "ip_addr_any" if the NTP
* server has not been configured by address (or at all).
*/