util: virnetlink: Fix the parameter description of functions

Some of function comments don't have the right named parameters
and others are not consistent with the description alignment.
This patch fixes this.

Signed-off-by: Chen Hanxiao <chenhanxiao@gmail.com>
This commit is contained in:
Chen Hanxiao 2018-02-06 19:38:17 +08:00 committed by John Ferlan
parent 68def01206
commit a90a1bf9e1

View File

@ -278,8 +278,8 @@ virNetlinkSendRequest(struct nl_msg *nl_msg, uint32_t src_pid,
/** /**
* virNetlinkCommand: * virNetlinkCommand:
* @nlmsg: pointer to netlink message * @nl_msg: pointer to netlink message
* @respbuf: pointer to pointer where response buffer will be allocated * @resp: pointer to pointer where response buffer will be allocated
* @respbuflen: pointer to integer holding the size of the response buffer * @respbuflen: pointer to integer holding the size of the response buffer
* on return of the function. * on return of the function.
* @src_pid: the pid of the process to send a message * @src_pid: the pid of the process to send a message
@ -387,9 +387,9 @@ virNetlinkDumpCommand(struct nl_msg *nl_msg,
* *
* @ifname: The name of the interface; only use if ifindex <= 0 * @ifname: The name of the interface; only use if ifindex <= 0
* @ifindex: The interface index; may be <= 0 if ifname is given * @ifindex: The interface index; may be <= 0 if ifname is given
* @data: Gets a pointer to the raw data from netlink. * @nlData: Gets a pointer to the raw data from netlink.
MUST BE FREED BY CALLER! MUST BE FREED BY CALLER!
* @nlattr: Pointer to a pointer of netlink attributes that will contain * @tb: Pointer to a pointer of netlink attributes that will contain
* the results * the results
* @src_pid: pid used for nl_pid of the local end of the netlink message * @src_pid: pid used for nl_pid of the local end of the netlink message
* (0 == "use getpid()") * (0 == "use getpid()")
@ -838,6 +838,7 @@ int virNetlinkEventServiceLocalPid(unsigned int protocol)
* *
* @protocol: netlink protocol * @protocol: netlink protocol
* @groups: broadcast groups to join in * @groups: broadcast groups to join in
*
* Returns -1 if the monitor cannot be registered, 0 upon success * Returns -1 if the monitor cannot be registered, 0 upon success
*/ */
int int