From 61a66292033cc4dd76e5747106a76af26c950929 Mon Sep 17 00:00:00 2001
From: Paul Duncan <pabs@pablotron.org>
Date: Wed, 10 Aug 2016 23:55:40 -0400
Subject: add docs for Archive getters

---
 src/zip.cr | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/zip.cr b/src/zip.cr
index be5fa56..4c4ad49 100644
--- a/src/zip.cr
+++ b/src/zip.cr
@@ -1768,7 +1768,29 @@ module Zip
     include Enumerable(Entry)
     include Iterable
 
-    getter :entries, :comment
+    #
+    # Return an array of entries in this Archive.
+    #
+    # Example:
+    #
+    #     Zip.read("foo.zip") do |zip|
+    #       # get an array of entries in this archive
+    #       entries = zip.entries
+    #     end
+    #
+    getter :entries
+
+    #
+    # Get the `Archive` comment as a String.
+    #
+    # Example:
+    #
+    #     Zip.read("foo.zip") do |zip|
+    #       # print archive comment
+    #       puts "comment: #{zip.comment}"
+    #     end
+    #
+    getter :comment
 
     #
     # Create new Zip::Archive from input Zip::Source.
@@ -1920,7 +1942,30 @@ module Zip
       @entries[id]?
     end
 
+    #
+    # Iterate over the entries in this `Archive`, or, if called without
+    # a block, return a lazy iterator.
+    #
+    # Example:
+    #
+    #     Zip.read("foo.zip") do |zip|
+    #       zip.each do |e|
+    #         type = e.dir? ? "directory" : "file"
+    #         puts "#{e.path} is a #{type}"
+    #       end
+    #     end
+    #
     delegate each, to: @entries
+
+    #
+    # Return the number of entries in this `Archive`.
+    #
+    # Example:
+    #
+    #     Zip.read("foo.zip") do |zip|
+    #       puts "foo.zip has #{zip.size} entries"
+    #     end
+    #
     delegate size, to: @entries
 
     ###################
-- 
cgit v1.2.3