tag:rubydoc.tenderapp.com,2010-12-26:/discussions/problems/321-missing-parts-of-the-documentationRubydoc.info: Discussion 2015-01-12T03:43:10Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792014-12-15T12:59:42Z2014-12-15T12:59:43ZMissing parts of the documentation<div><p>Hi,</p>
<p>It seem that some parts of the documentation are missing
from:</p>
<p><a href=
"http://www.rubydoc.info/gems/ruby-fizzbuzz/0.7.0/frames">http://www.rubydoc.info/gems/ruby-fizzbuzz/0.7.0/frames</a></p>
<p>Especially, the instance methods, etc.</p>
<p>I am not entirely sure what is wrong, or whether it is something
I've done to upset the system.<br>
Having said that, when I render documentation locally, it seem
correct.</p>
<p>Thank you for help in advance!</p>
<p>Regards,<br>
Krzysztof</p></div>tag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792014-12-22T22:30:39Z2014-12-22T22:30:39ZMissing parts of the documentation<div><p>Sorry about the delayed response. Can you elaborate a little bit
as I'm not familiar with the gem itself? Does documentation
generate fine locally using yard's built-in server? But the docs on
rubydoc.info do not match up? Or is this an issue with yardoc
locally too?</p></div>naptag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792014-12-23T01:43:48Z2014-12-23T01:43:49ZMissing parts of the documentation<div><p>Hi,</p>
<p>No problem! Thank you for getting back to me.</p>
<p>Basically, it seems that none of the C files containing code
comments are<br>
parsed any more, only Ruby code.</p>
<p>But, both RDoc and Yard seem to render everything fine when
asked to do so<br>
locally (on my notebook, for example).</p>
<p>I am not sure what changed, but it used to work just fine :)</p>
<p>Best,<br>
Krzysztof</p></div>krzysztof.wilczynskitag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792014-12-23T01:48:18Z2014-12-23T01:48:18ZMissing parts of the documentation<div><p>What version of YARD are you using locally?</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792015-01-11T01:02:32Z2015-01-11T01:02:32ZMissing parts of the documentation<div><p>Hi,</p>
<p>Happy New Year!</p>
<p>Apologies! I missed your reply in my inbox (moved to Google
Inbox and can't<br>
find things sometimes now).</p>
<p>I state corrected - yard will also skip ../ext/*.c files
completely. I've<br>
tried versions from 0.8.3 to 0.8.7.6. Using Rubies 1.9.3-p551,
2.1.0 and<br>
2.2.0. Not much luck. rdoc 4.1.2 seem to be working fine.</p>
<p>Example:</p>
<ul>
<li>yard</li>
</ul>
<p>kwilczynski@apple ~/Projects/Personal/ruby-fizzbuzz (master %)$
yard<br>
Files: 6<br>
Modules: 0 ( 0 undocumented)<br>
Classes: 5 ( 0 undocumented)<br>
Constants: 2 ( 0 undocumented)<br>
Methods: 13 ( 0 undocumented)<br>
100.00% documented</p>
<ul>
<li>rdoc</li>
</ul>
<p>kwilczynski@apple ~/Projects/Personal/ruby-fizzbuzz (master %)$
rdoc<br>
Parsing sources...<br>
100% [100/100] test/test_fizzbuzz.rb</p>
<p>Generating Darkfish format into<br>
/Users/kwilczynski/Development/Projects/Personal/ruby-fizzbuzz/doc...</p>
<p>Files: 100</p>
<p>Classes: 8 (0 undocumented) Modules: 0 (0 undocumented)
Constants: 1 (0 undocumented) Attributes: 2 (0 undocumented)
Methods: 26 (0 undocumented)</p>
<p>Total: 37 (0 undocumented) 100.00% documented</p>
<p>If there is anything I can do to help, please let me know!</p>
<p>Regards,<br>
Krzysztof</p></div>krzysztof.wilczynskitag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792015-01-11T01:34:34Z2015-01-11T01:34:34ZMissing parts of the documentation<div><p>Looks like it's related to support (or lack thereof) of
<code>#if</code> in YARD. You can open an <a href=
"http://github.com/lsegal/yard/issues">issue for this</a> or IMO
just remove it since you can configure your makefile to just use a
proper C compiler and not a C++ compiler.</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/355459792015-01-12T03:43:10Z2015-01-12T03:43:10ZMissing parts of the documentation<div><p>Hey,</p>
<p>Thanks! Good catch. I think, I will lean towards adding support
for it.<br>
Having said that, it does work for<br>
<a href=
"http://www.rubydoc.info/gems/ruby-magic/0.0.1/Magic">http://www.rubydoc.info/gems/ruby-magic/0.0.1/Magic</a>
just fine. I am also<br>
using __cplusplus guard there too.</p>
<p>What do you think?</p>
<p>Krzysztof</p></div>krzysztof.wilczynski