Check for documentation coverage in GitHub Actions (#35)

* Add missing docs
* Add `yard` as development dependency

Author: ShockwaveNN

.github/workflows/ruby.yml

@@ -25,3 +25,5 @@ jobs:
         markdownlint *.md
     - name: Check source files using `rubocop`
       run: rubocop
+    - name: Check that code 100% documented
+      run: yardoc . | grep -q '100.00% documented'

CHANGELOG.md

@@ -11,6 +11,9 @@
 * Add `rubocop` check to GitHub Actions
 * Add `rubocop-rake` support
 * Add `markdownlint` checks in GitHub Actions
+* Add missing documentation
+* Check for documentation coverage in GitHub Actions
+* Add `yard` as development dependency
 
 ### Fixes
 

Gemfile

@@ -15,4 +15,5 @@ end
 
 group :development do
   gem 'overcommit', require: false
+  gem 'yard', require: false
 end

lib/onlyoffice_bugzilla_helper/name.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module OnlyofficeBugzillaHelper
+  # [String] name of gem
   NAME = 'onlyoffice_bugzilla_helper'
 end

lib/onlyoffice_bugzilla_helper/update_bug.rb

@@ -3,6 +3,10 @@
 module OnlyofficeBugzillaHelper
   # Method to updating bug data
   module UpdateBug
+    # Update bug info
+    # @param bug_id [Integer] id of bug
+    # @param params [Hash] params to update
+    # @return [Net::HTTPResponse] result of update
     def update_bug(bug_id, params = {})
       req = Net::HTTP::Put.new(bug_url(bug_id))
       req.body = params.to_json

lib/onlyoffice_bugzilla_helper/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module OnlyofficeBugzillaHelper
+  # [String] version of Gem
   VERSION = '0.3.2'
 end