Skip to content

Commit cf8d017

Browse files
committed
Add some doc comments
1 parent 8ad9a92 commit cf8d017

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lib/arduino_ci/arduino_cmd.rb

+3
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ class ArduinoCmd
99
class << self
1010
protected :new
1111

12+
# @return [ArduinoCmd] A command object with a best guess (or nil) for the installation
1213
def autolocate
1314
new(ArduinoInstallation.autolocate)
1415
end
1516

17+
# @return [ArduinoCmd] A command object, installing Arduino if necessary
1618
def autolocate!
1719
new(ArduinoInstallation.autolocate!)
1820
end
@@ -21,6 +23,7 @@ def autolocate!
2123

2224
attr_accessor :installation
2325

26+
# @param installation [ArduinoInstallation] the location of the Arduino program installation
2427
def initialize(installation)
2528
@display_mgr = DisplayManager::instance
2629
@installation = installation

0 commit comments

Comments
 (0)