Class overview is not being generated about yard

[lsegal]

When you say class overview, what are you referring to? http://yardoc.org/docs/TwP-servolux looks right to me

[TwP]

The Servolux::Daemon class has a lengthy explanation of how to use the class just above the class declaration. RDoc will capture this class comment and put it at the top of the file. Yard used to do this (version 2.3.5.1) but the latest release no longer pulls in this data for this particular gem.

http://github.com/TwP/servolux/blob/master/lib/servolux/daemon.rb

All the leading commentary is not showing up in yardoc output.

TwP

If you would like a more real-time conversation, IM me at tim(dot)pease(at)gmail(dot)com using your favorite jabber IM client.

[lsegal]

Okay, I confirmed this bug in with the legacy parser and in 1.8. Should be fixed soon.

[lsegal]

Note that you have a "# class Servolux::Daemon" following the end of your class definition. If you remove that, the prepended comments should show up- YARD is just getting confused because it accepts both prepended comments and comments appended to the end of the line. I will make it so that the legacy parser takes the prepended comments at a higher precedence.

[lsegal]

Legacy parser should prioritize prepended comments over appended ones.

Closed by e545ba0

[sprsquish]

I'm still getting this error. I pulled down the change you made, installed the gem and run it against my project. The odd thing is that it caught and parsed the text for one class, but no others.

[lsegal]

Which one is yours?

[sprsquish]

http://github.com/sprsquish/blather/tree/better-docs

the "better-docs" branch of Blather

[lsegal]

It looks correct to me: http://yardoc.org/docs/sprsquish-blather/Blather/Client

Anything wrong on any of the pages? I'm seeing everything you would expect.

[sprsquish]

hm.. that all looks right. what options did you pass in?

I'm building my docs with the rake task. And I don't get the search box in the upper left

[lsegal]

The search box is a customization for the live docs at yardoc.org. I tested this locally, though, and I get the same results. I simply used yardoc in the base directory, which is what the Rake task does by default as well. Verify that you've properly updated yard (yardoc -v), and make sure to delete 0.2.3.5 if you still have it, the rubygems plugin is known to interfere.

[sprsquish]

ah.. It works on ruby 1.9 not on 1.8.7

[lsegal]

I tested this in 1.8 as well. Same result:

Generated on Tue Nov 17 02:15:51 2009 by yard 0.4.0 (ruby-1.8.7).

[lsegal]

Perhaps your gem install in 1.8 is not using the stable branch and doesn't have the recent changes?

[sprsquish]

I updated both from the cloned repo.

The other odd thing is that the Index isn't in alphabetical order on 1.8.7.

[lsegal]

Thanks, index ordering is fixed in 1.8, but I still get proper data when generating for your project in 1.8.