summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Schlaeger <chris@linux.com>2017-02-01 21:19:27 +0100
committerChris Schlaeger <chris@linux.com>2017-02-01 21:19:27 +0100
commit7decdea39e5348e478db70ed847a25df8faab6ca (patch)
treeaa1246fae991264cfd247c90750226e42066faee
parent3358b26e75e8a367477fe0045d73de13a0ff5277 (diff)
downloadpostrunner-7decdea39e5348e478db70ed847a25df8faab6ca.zip
Fix doc errors.
-rw-r--r--lib/postrunner/ActivitiesDB.rb3
-rw-r--r--lib/postrunner/MonitoringStatistics.rb2
-rw-r--r--lib/postrunner/ViewButtons.rb2
3 files changed, 4 insertions, 3 deletions
diff --git a/lib/postrunner/ActivitiesDB.rb b/lib/postrunner/ActivitiesDB.rb
index c98af2d..4c7c78c 100644
--- a/lib/postrunner/ActivitiesDB.rb
+++ b/lib/postrunner/ActivitiesDB.rb
@@ -85,7 +85,8 @@ module PostRunner
end
# Add a new FIT file to the database.
- # @param fit_file [String] Name of the FIT file.
+ # @param fit_file_name [String] Name of the FIT file.
+ # @param fit_activity [Activity] Activity to add
# @return [TrueClass or FalseClass] True if the file could be added. False
# otherwise.
def add(fit_file_name, fit_activity)
diff --git a/lib/postrunner/MonitoringStatistics.rb b/lib/postrunner/MonitoringStatistics.rb
index d3b2c1d..fb8daea 100644
--- a/lib/postrunner/MonitoringStatistics.rb
+++ b/lib/postrunner/MonitoringStatistics.rb
@@ -80,7 +80,7 @@ module PostRunner
end
# Generate a report for a certain week.
- # @param day [String] Date of a day in that week as YYYY-MM-DD string.
+ # @param start_day [String] Date of a day in that week as YYYY-MM-DD string.
def weekly(start_day)
"Monitoring Statistics for the week of " +
"#{start_day.strftime('%Y-%m-%d')}\n\n" +
diff --git a/lib/postrunner/ViewButtons.rb b/lib/postrunner/ViewButtons.rb
index 4c95162..43b3181 100644
--- a/lib/postrunner/ViewButtons.rb
+++ b/lib/postrunner/ViewButtons.rb
@@ -18,7 +18,7 @@ module PostRunner
class ViewButtons
# Create a ViewButtons object.
- # @params views [Array of NavButtonDef] icons and URLs for all pages.
+ # @param views [Array of NavButtonDef] icons and URLs for all pages.
def initialize(views)
if views.empty?
raise ArgumentError.new("'views' must not be empty")