search

defunkt / tomdoc

A TomDoc Ruby library.
http://tomdoc.org/
MIT License
114 stars 16 forks source link

Does not generate any documentation #34

Open Overbryd opened 10 years ago

Overbryd commented 10 years ago

Hi,

I started using tomdoc (see the file http_client.rb in this branch). I quadrupled checked the spec with what I have written to see if I am violating any rules. But whatever I try, it does not generate any documentation for me. Sad.

$ tomdoc lib/http_client.rb 
--------------------------------------------------------------------------------
HttpClient

coding: utf-8

Is there something obvious I am missing?

I am using the tomdoc (0.2.5) gem with JRuby 1.7.6 in 1.9 mode.

Cheers, Lukas

Overbryd commented 10 years ago

Using yard and the yard-tomdoc plugin it worked just fine.

$ gem install yard
$ gem install yard-tomdoc
$ yard doc --plugin tomdoc lib/http_client.rb
trans commented 10 years ago

Hi, I am not sure why tomdoc gem isn't working, but I do know that the yard-tomdoc gem uses the tomparse gem to handle the doc parsing. What probably needs to happen is for someone that has the time to update tomdoc to use tomparse as it's backend parser (see #22). Then tomdoc would be in much better shape (let alone work).