Skip to content

Commit d9a8b40

Browse files
authored
Merge pull request #38 from nobu/doc
[DOC] Complete RDoc coverage
2 parents d9968b5 + bbb1e23 commit d9a8b40

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

.document

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
BSDL
2+
COPYING
3+
README.md
4+
lib/

lib/pstore.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,12 +326,14 @@
326326
# end
327327
#
328328
class PStore
329+
# :stopdoc:
329330
VERSION = "0.2.0"
330331

331332
RDWR_ACCESS = {mode: IO::RDWR | IO::CREAT | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
332333
RD_ACCESS = {mode: IO::RDONLY | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
333334
WR_ACCESS = {mode: IO::WRONLY | IO::CREAT | IO::TRUNC | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
334335
private_constant :RDWR_ACCESS, :RD_ACCESS, :WR_ACCESS
336+
# :startdoc:
335337

336338
# The error type thrown by all PStore methods.
337339
class Error < StandardError
@@ -592,6 +594,8 @@ def transaction(read_only = false) # :yields: pstore
592594
end
593595

594596
private
597+
# :stopdoc:
598+
595599
# Constant for relieving Ruby's garbage collector.
596600
CHECKSUM_ALGO = %w[SHA512 SHA384 SHA256 SHA1 RMD160 MD5].each do |algo|
597601
begin

0 commit comments

Comments
 (0)