commenting

Author: ianfixes

lib/arduino_ci/ci_config.rb

@@ -147,15 +147,19 @@ def platform_definition(platform_name)
       deep_clone(defn)
     end
 
+    # the URL that gives the download info for a given package (a JSON file).
+    # this is NOT where the package comes from.
     def package_url(package)
       return nil if @package_info[package].nil?
       @package_info[package][:url]
     end
 
+    # platforms to build [the examples on]
     def platforms_to_build
       @compile_info[:platforms]
     end
 
+    # platforms to unit test [the tests on]
     def platforms_to_unittest
       @unittest_info[:platforms]
     end

lib/arduino_ci/cpp_library.rb

@@ -23,31 +23,38 @@ def cpp_files_in(some_dir)
       Find.find(some_dir).select { |path| CPP_EXTENSIONS.include?(File.extname(path)) }
     end
 
+    # CPP files that are part of the project library under test
     def cpp_files
       cpp_files_in(@base_dir).reject { |p| p.start_with?(tests_dir) }
     end
 
+    # CPP files that are part of the arduino mock library we're providing
     def cpp_files_arduino
       cpp_files_in(ARDUINO_HEADER_DIR)
     end
 
+    # CPP files that are part of the unit test library we're providing
     def cpp_files_unittest
       cpp_files_in(UNITTEST_HEADER_DIR)
     end
 
+    # The directory where we expect to find unit test defintions provided by the user
     def tests_dir
       File.join(@base_dir, "test")
     end
 
+    # The files provided by the user that contain unit tests
     def test_files
       cpp_files_in(tests_dir)
     end
 
+    # Find all directories in the project library that include C++ header files
     def header_dirs
       files = Find.find(@base_dir).select { |path| HPP_EXTENSIONS.include?(File.extname(path)) }
       files.map { |path| File.dirname(path) }.uniq
     end
 
+    # wrapper for the GCC command
     def run_gcc(*args, **kwargs)
       # TODO: detect env!!
       full_args = ["g++"] + args