lib/uri/ssh_git/generic.rb in uri-ssh_git-0.1.1 vs lib/uri/ssh_git/generic.rb in uri-ssh_git-0.1.2

@@ -1,7 +1,17 @@
 module URI
   module SshGit
+    # @see http://docs.ruby-lang.org/en/2.2.0/URI/Generic.html
     class Generic < ::URI::Generic
+      # @example
+      #   Generic.build(
+      #     userinfo: 'git',
+      #     host: 'github.com',
+      #     path: '/packsaddle/ruby-uri-ssh_git.git'
+      #   ).to_s
+      #   #=> '[e-mail]:packsaddle/ruby-uri-ssh_git.git'
+      #
+      # @return [String] git repository url via ssh protocol
       def to_s
         show_path = path.slice(1..-1) if path.start_with?('/')
         "#{user}@#{host}:#{show_path}"
       end
     end