beckermj/vaguerent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client/target_index: Make yard comments conformant

Browse Source
This commit is contained in:
Paul Hinze 2022-05-03 12:34:50 -05:00
parent 027a0b9afa
commit 102e100108
No known key found for this signature in database
GPG Key ID: B69DEDF2D55501C0
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
plugins/commands/serve/client/target_index.rb
View File

@ -2,7 +2,7 @@ module VagrantPlugins
module CommandServe
class Client
class TargetIndex < Client
# @param [string]
# @param [String]
# @return [Boolean] true if delete is successful
def delete(ident)
logger.debug("deleting machine with id #{ident} from index")
@ -14,8 +14,8 @@ module VagrantPlugins
true
end
# @param [string]
# @return [MachineIndex::Entry]
# @param [String]
# @return [Vagrant::MachineIndex::Entry]
def get(ident)
logger.debug("getting machine with id #{ident} from index")
begin
@ -31,7 +31,7 @@ module VagrantPlugins
end
end
# @param [string]
# @param [String]
# @return [Boolean]
def include?(ident)
logger.debug("checking for machine with id #{ident} in index")
@ -42,8 +42,8 @@ module VagrantPlugins
).exists
end
# @param [MachineIndex::Entry]
# @return [MachineIndex::Entry]
# @param [Vagrant::MachineIndex::Entry]
# @return [Vagrant::MachineIndex::Entry]
def set(entry)
logger.debug("setting machine #{entry} in index")
if entry.id.to_s.empty?
@ -62,7 +62,7 @@ module VagrantPlugins
end
# Get all targets
# @return [Array<MachineIndex::Entry>]
# @return [Array<Vagrant::MachineIndex::Entry>]
def all
logger.debug("getting all machines")
client.all(Empty.new).targets.map do |t_ref|