Skip to content

Commit e262b91

Browse files
aborzeszwesteri
authored andcommitted
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>
1 parent 6f3ed98 commit e262b91

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

drivers/thunderbolt/tunnel.h

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,11 @@ void tb_tunnel_deactivate(struct tb_tunnel *tunnel);
142142
* tb_tunnel_is_active() - Is tunnel fully activated
143143
* @tunnel: Tunnel to check
144144
*
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.
149150
*/
150151
static inline bool tb_tunnel_is_active(const struct tb_tunnel *tunnel)
151152
{

0 commit comments

Comments
 (0)