Home → Problems →

Missing parts of the documentation

• Edit

krzysztof.wilczynski

15 Dec, 2014 12:59 PM

Hi,

It seem that some parts of the documentation are missing from:

http://www.rubydoc.info/gems/ruby-fizzbuzz/0.7.0/frames

Especially, the instance methods, etc.

I am not entirely sure what is wrong, or whether it is something I've done to upset the system.
Having said that, when I render documentation locally, it seem correct.

Thank you for help in advance!

Regards,
Krzysztof

1. Support Staff 1 Posted by nap on 22 Dec, 2014 10:30 PM

   

   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?

   • Edit

2. 2 Posted by krzysztof.wilcz... on 23 Dec, 2014 01:43 AM

   

   Hi,

   No problem! Thank you for getting back to me.

   Basically, it seems that none of the C files containing code comments are
   parsed any more, only Ruby code.

   But, both RDoc and Yard seem to render everything fine when asked to do so
   locally (on my notebook, for example).

   I am not sure what changed, but it used to work just fine :)

   Best,
   Krzysztof

   • Edit

3. Support Staff 3 Posted by lsegal on 23 Dec, 2014 01:48 AM

   

   What version of YARD are you using locally?

   • Edit

4. 4 Posted by krzysztof.wilcz... on 11 Jan, 2015 01:02 AM

   

   Hi,

   Happy New Year!

   Apologies! I missed your reply in my inbox (moved to Google Inbox and can't
   find things sometimes now).

   I state corrected - yard will also skip ../ext/*.c files completely. I've
   tried versions from 0.8.3 to 0.8.7.6. Using Rubies 1.9.3-p551, 2.1.0 and
   2.2.0. Not much luck. rdoc 4.1.2 seem to be working fine.

   Example:

   - yard

   kwilczynski@apple ~/Projects/Personal/ruby-fizzbuzz (master %)$ yard
   Files: 6
   Modules: 0 ( 0 undocumented)
   Classes: 5 ( 0 undocumented)
   Constants: 2 ( 0 undocumented)
   Methods: 13 ( 0 undocumented)
    100.00% documented

   - rdoc

   kwilczynski@apple ~/Projects/Personal/ruby-fizzbuzz (master %)$ rdoc
   Parsing sources...
   100% [100/100] test/test_fizzbuzz.rb

   Generating Darkfish format into
   /Users/kwilczynski/Development/Projects/Personal/ruby-fizzbuzz/doc...

     Files: 100

     Classes: 8 (0 undocumented)
     Modules: 0 (0 undocumented)
     Constants: 1 (0 undocumented)
     Attributes: 2 (0 undocumented)
     Methods: 26 (0 undocumented)

     Total: 37 (0 undocumented)
     100.00% documented

   If there is anything I can do to help, please let me know!

   Regards,
   Krzysztof

   • Edit

5. Support Staff 5 Posted by lsegal on 11 Jan, 2015 01:34 AM

   

   Looks like it's related to support (or lack thereof) of #if in YARD. You can open an issue for this or IMO just remove it since you can configure your makefile to just use a proper C compiler and not a C++ compiler.

   • Edit

6. 6 Posted by krzysztof.wilcz... on 12 Jan, 2015 03:43 AM

   

   Hey,

   Thanks! Good catch. I think, I will lean towards adding support for it.
   Having said that, it does work for
   http://www.rubydoc.info/gems/ruby-magic/0.0.1/Magic just fine. I am also
   using __cplusplus guard there too.

   What do you think?

   Krzysztof

   • Edit