From ed97d1e5c3edcae69d71edc15f83567e7cd04a09 Mon Sep 17 00:00:00 2001 From: pjht Date: Fri, 8 May 2020 07:45:01 -0500 Subject: [PATCH] Documentation work --- lib/rcircuit/gate.rb | 1 + lib/rcircuit/vcd.rb | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/rcircuit/gate.rb b/lib/rcircuit/gate.rb index e1bc01f..9124f91 100644 --- a/lib/rcircuit/gate.rb +++ b/lib/rcircuit/gate.rb @@ -43,6 +43,7 @@ class Gate # @param table [Array>] The truth table, # which is an array of entries. The last value in the entry is the expected output, # the rest are the inputs to the ports. + # @return [Boolean] Whether the truth table matches the gate's behavior def self.test_table(table) ports=[] (table[0].length-1).times do diff --git a/lib/rcircuit/vcd.rb b/lib/rcircuit/vcd.rb index aaf6989..eaaa04c 100644 --- a/lib/rcircuit/vcd.rb +++ b/lib/rcircuit/vcd.rb @@ -2,7 +2,8 @@ class VCD # @!attribute [w] fd - # @api private + # @api private + # Used for testing to set the file to an RSpec double. attr_writer :fd # @param filename [String] The filename to output to # @param timescale [String] The timescale