Merge pull request #21 from abotalov/fix_yardocs

jarib · jarib · commit 994603ee0746 · 2013-12-18T13:26:05.000-08:00
Fix yard comments
diff --git a/lib/browsermob/proxy/client.rb b/lib/browsermob/proxy/client.rb
@@ -26,8 +26,7 @@ def initialize(resource, host, port)
       end
 
       #
-      # Examples:
-      #
+      # @example
       #   client.new_har("page-name")
       #   client.new_har("page-name", :capture_headers => true)
       #   client.new_har(:capture_headers => true)
@@ -154,7 +153,8 @@ def timeouts(timeouts = {})
       # Each invocation of the method will add given hosts to existing BrowserMob's DNS cache
       # instead of overriding it.
       #
-      # @example remap_dns_hosts('example.com' => '1.2.3.4')
+      # @example
+      #   remap_dns_hosts('example.com' => '1.2.3.4')
       # @param hash [Hash] a hash with domains as keys and IPs as values
       #
 

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,7 @@ def initialize(resource, host, port)`
`26`	`26`	`end`
`27`	`27`
`28`	`28`	`#`
`29`		`- # Examples:`
`30`		`- #`
	`29`	`+ # @example`
`31`	`30`	`# client.new_har("page-name")`
`32`	`31`	`# client.new_har("page-name", :capture_headers => true)`
`33`	`32`	`# client.new_har(:capture_headers => true)`
`@@ -154,7 +153,8 @@ def timeouts(timeouts = {})`
`154`	`153`	`# Each invocation of the method will add given hosts to existing BrowserMob's DNS cache`
`155`	`154`	`# instead of overriding it.`
`156`	`155`	`#`
`157`		`- # @example remap_dns_hosts('example.com' => '1.2.3.4')`
	`156`	`+ # @example`
	`157`	`+ # remap_dns_hosts('example.com' => '1.2.3.4')`
`158`	`158`	`# @param hash [Hash] a hash with domains as keys and IPs as values`
`159`	`159`	`#`
`160`	`160`