<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Resolved To Test &#187; RDoc</title>
	<atom:link href="http://www.resolvedtotest.com/tag/rdoc/feed/" rel="self" type="application/rss+xml" />
	<link>http://www.resolvedtotest.com</link>
	<description>Two testers, one blog.</description>
	<lastBuildDate>Sat, 26 Jun 2010 02:27:19 +0000</lastBuildDate>
	<generator>http://wordpress.org/?v=2.9.2</generator>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
			<item>
		<title>RubyGems: RDoc Information on Installed Gems</title>
		<link>http://www.resolvedtotest.com/2009/04/16/rubygems-rdoc-information-on-installed-gems/</link>
		<comments>http://www.resolvedtotest.com/2009/04/16/rubygems-rdoc-information-on-installed-gems/#comments</comments>
		<pubDate>Thu, 16 Apr 2009 21:53:29 +0000</pubDate>
		<dc:creator>Maura van der Linden</dc:creator>
				<category><![CDATA[Maura]]></category>
		<category><![CDATA[ruby]]></category>
		<category><![CDATA[Gems]]></category>
		<category><![CDATA[RDoc]]></category>
		<category><![CDATA[RubyGems]]></category>

		<guid isPermaLink="false">http://www.resolvedtotest.com/?p=49</guid>
		<description><![CDATA[It can be useful to view the RDoc information for the various gems you may have installed on your local system. RubyGems provides a way to do this by starting up a local RDoc server.
Local Gem Server
To start the server, open a command window on the machine that has RubyGems installed and type:
 gem server [...]]]></description>
			<content:encoded><![CDATA[<p>It can be useful to view the RDoc information for the various gems you may have installed on your local system. RubyGems provides a way to do this by starting up a local RDoc server.</p>
<p><strong>Local Gem Server</strong><br />
To start the server, open a command window on the machine that has RubyGems installed and type:</p>
<blockquote><p><code> gem server </code></p></blockquote>
<p>Once the you get a message that the server is starting, you can minimize this command window (don&#8217;t close it or the server will stop). </p>
<p>Using your browser of choice, navigate to http://localhost:8808.</p>
<p>When you open this page, you will see a list of all the gems you have installed on the local system and each one will have an WWW link that will open the project&#8217;s homepage as well as an RDoc link that will open the RDoc information for that particular gem. At the top of the page are three columns: Files, Classes and Methods. I tend to find Classes and Methods the most useful when trying to discover usage and syntax for a gem.</p>
<p>If you click on methods displayed in the RDocs, an small pop-up will open to show you the code relating to the method. This can be even more useful if you are trying to figure out how to use a method.</p>
<p><strong>Missing RDoc Information</strong><br />
There might be a situation where you have a gem installed that does not have RDoc information but you can force RubyGems to generate RDoc information for already installed gems. </p>
<blockquote><p><code>gem rdoc --all</code></p></blockquote>
<p>This will generate the RDoc information for all installed gems. You can also generate RDoc for select gems only by using:</p>
<blockquote><p><code>gem rdoc GEMNAME</code></p></blockquote>


<div class="shr-bookmarks shr-bookmarks-expand">
<ul class="socials">
		<li class="sexy-delicious">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-digg">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-technorati">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-facebook">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-twitter">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-comfeed">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-linkedin">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-google">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-squidoo">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
		<li class="sexy-blogger">
			<a href="" rel="nofollow" class="external" title=""></a>
		</li>
</ul>
<div style="clear:both;"></div>
</div>

]]></content:encoded>
			<wfw:commentRss>http://www.resolvedtotest.com/2009/04/16/rubygems-rdoc-information-on-installed-gems/feed/</wfw:commentRss>
		<slash:comments>1</slash:comments>
		</item>
	</channel>
</rss>
