From: Yusuke Endoh <mame@...>
Date: 2011-05-24T21:25:18+09:00
Subject: [ruby-core:36422] [Ruby 1.9 - Bug #4711][Open] documentation updates: Net::POP3 and Net::Telnet are 100%


Issue #4711 has been updated by Yusuke Endoh.

Status changed from Closed to Open

Hello,

+    # internal method for Net::POP3.start
     def do_start(account, password)

+    # Does nothing
     def on_connect
     end
     private :on_connect

+    # nil's out the:
+    # - mails
+    # - number counter for mails
+    # - number counter for bytes
+    # - quits the current command, if any
     def do_finish


Is any comment needed there?
If so, they should be more verbose.
I think that :nodoc: is a good idea here.

-- 
Yusuke Endoh <mame@tsg.ne.jp>
----------------------------------------
Bug #4711: documentation updates: Net::POP3 and Net::Telnet are 100%
http://redmine.ruby-lang.org/issues/4711

Author: Vincent Batts
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.3
ruby -v: ruby 1.9.3dev (2011-05-16 trunk 31589) [x86_64-linux]


per http://blog.segment7.net/2011/05/09/ruby-1-9-3-documentation-challenge

This patch includes the following bits.


class Net::Telnet # is documented

  # in file lib/net/telnet.rb
  def close(); end 

end


class Net::POP3 # is documented

  # in file lib/net/pop.rb
  Revision = nil 
  # in file lib/net/pop.rb
  def certs(); end 

  # in file lib/net/pop.rb
  def create_ssl_params(verify_or_params = {}, certs = nil); end 

  # in file lib/net/pop.rb
  def ssl_params(); end 

  # in file lib/net/pop.rb
  def use_ssl?(); end 

  # in file lib/net/pop.rb
  def verify(); end 

  # in file lib/net/pop.rb
  def command(); end 

  # in file lib/net/pop.rb
  def disable_ssl(); end 

  # in file lib/net/pop.rb
  def do_finish(); end 

  # in file lib/net/pop.rb
  def do_start(account, password); end 

  # in file lib/net/pop.rb
  def logging(msg); end 

  # in file lib/net/pop.rb
  def on_connect(); end 

end



-- 
http://redmine.ruby-lang.org