Skip to content

Commit 943ce17

Browse files
committed
refactor(bash_completion): adjust doc comment format
1 parent 6f1bbda commit 943ce17

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

bash_completion

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ dequote()
165165
# will not unshadow the global variable. Rather, the result will be a local
166166
# variable in an unset state.
167167
# Usage: local IFS='|'; _comp_unlocal IFS
168-
# Param: $* Variable names to be unset
168+
# @param $* Variable names to be unset
169169
_comp_unlocal()
170170
{
171171
if ((BASH_VERSINFO[0] >= 5)) && shopt -q localvar_unset; then
@@ -179,13 +179,13 @@ _comp_unlocal()
179179

180180
# Assign variable one scope above the caller
181181
# Usage: local "$1" && _upvar $1 "value(s)"
182-
# Param: $1 Variable name to assign value to
183-
# Param: $* Value(s) to assign. If multiple values, an array is
182+
# @param $1 Variable name to assign value to
183+
# @param $* Value(s) to assign. If multiple values, an array is
184184
# assigned, otherwise a single value is assigned.
185185
# NOTE: For assigning multiple variables, use '_upvars'. Do NOT
186186
# use multiple '_upvar' calls, since one '_upvar' call might
187187
# reassign a variable to be used by another '_upvar' call.
188-
# See: https://fvue.nl/wiki/Bash:_Passing_variables_by_reference
188+
# @see https://fvue.nl/wiki/Bash:_Passing_variables_by_reference
189189
_upvar()
190190
{
191191
echo "bash_completion: $FUNCNAME: deprecated function," \
@@ -205,8 +205,8 @@ _upvar()
205205
# Available OPTIONS:
206206
# -aN Assign next N values to varname as array
207207
# -v Assign single value to varname
208-
# Return: 1 if error occurs
209-
# See: https://fvue.nl/wiki/Bash:_Passing_variables_by_reference
208+
# @return 1 if error occurs
209+
# @see https://fvue.nl/wiki/Bash:_Passing_variables_by_reference
210210
_upvars()
211211
{
212212
if ! (($#)); then
@@ -1831,13 +1831,14 @@ _included_ssh_config_files()
18311831
# Also hosts from HOSTFILE (compgen -A hostname) are added, unless
18321832
# BASH_COMPLETION_KNOWN_HOSTS_WITH_HOSTFILE is set to an empty value.
18331833
# Usage: _known_hosts_real [OPTIONS] CWORD
1834-
# Options: -a Use aliases from ssh config files
1835-
# -c Use `:' suffix
1836-
# -F configfile Use `configfile' for configuration settings
1837-
# -p PREFIX Use PREFIX
1838-
# -4 Filter IPv6 addresses from results
1839-
# -6 Filter IPv4 addresses from results
1840-
# Return: Completions, starting with CWORD, are added to COMPREPLY[]
1834+
# Options:
1835+
# -a Use aliases from ssh config files
1836+
# -c Use `:' suffix
1837+
# -F configfile Use `configfile' for configuration settings
1838+
# -p PREFIX Use PREFIX
1839+
# -4 Filter IPv6 addresses from results
1840+
# -6 Filter IPv4 addresses from results
1841+
# @return Completions, starting with CWORD, are added to COMPREPLY[]
18411842
_known_hosts_real()
18421843
{
18431844
local configfile flag prefix=""

0 commit comments

Comments
 (0)