Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

thunderbolt: Update tunnel.h function documentation

Make tunnel.h function documentation compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>

authored by

Alan Borzeszkowski and committed by
Mika Westerberg
e262b91b 6f3ed985

+5 -4
+5 -4
drivers/thunderbolt/tunnel.h
··· 142 142 * tb_tunnel_is_active() - Is tunnel fully activated 143 143 * @tunnel: Tunnel to check 144 144 * 145 - * Returns %true if @tunnel is fully activated. For other than DP 146 - * tunnels this is pretty much once tb_tunnel_activate() returns 147 - * successfully. However, for DP tunnels this returns %true only once the 148 - * DPRX capabilities read has been issued successfully. 145 + * Return: %true if @tunnel is fully activated. 146 + * 147 + * Note for DP tunnels this returns %true only once the DPRX capabilities 148 + * read has been issued successfully. For other tunnels, this function 149 + * returns %true pretty much once tb_tunnel_activate() returns successfully. 149 150 */ 150 151 static inline bool tb_tunnel_is_active(const struct tb_tunnel *tunnel) 151 152 {