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>
pull/1354/merge
Alan Borzeszkowski 2025-08-27 13:56:42 +02:00 committed by Mika Westerberg
parent 6f3ed985b7
commit e262b91b22
1 changed files with 5 additions and 4 deletions

View File

@ -142,10 +142,11 @@ void tb_tunnel_deactivate(struct tb_tunnel *tunnel);
* tb_tunnel_is_active() - Is tunnel fully activated * tb_tunnel_is_active() - Is tunnel fully activated
* @tunnel: Tunnel to check * @tunnel: Tunnel to check
* *
* Returns %true if @tunnel is fully activated. For other than DP * Return: %true if @tunnel is fully activated.
* tunnels this is pretty much once tb_tunnel_activate() returns *
* successfully. However, for DP tunnels this returns %true only once the * Note for DP tunnels this returns %true only once the DPRX capabilities
* DPRX capabilities read has been issued successfully. * read has been issued successfully. For other tunnels, this function
* returns %true pretty much once tb_tunnel_activate() returns successfully.
*/ */
static inline bool tb_tunnel_is_active(const struct tb_tunnel *tunnel) static inline bool tb_tunnel_is_active(const struct tb_tunnel *tunnel)
{ {