RDoc не генерирует исходные файлы - PullRequest
Новая
       10

RDoc не генерирует исходные файлы

2 голосов
/ 25 апреля 2011

Я использую Rdoc 2.58 с Ruby 1.9.2p138.Когда я генерирую свои файлы rdoc, используя формат Darkfish (который является единственным вариантом), я не получаю предварительный просмотр исходного кода вместе с ним.Нет сообщений об ошибках, и файлы HTML генерируются для всех классов.

Я пытался обновить гем и читать файлы справки, но я не вижу способа исправить эту проблему.

Это известная проблема?Что еще можно попробовать?

ОБНОВЛЕНИЕ:

пример кода: 

class Iamaclass
    def initialize
        @name = "superclass"
    end

    def get_name
        @name
    end

    def proud?
        true
    end
end

Rdoc 2.5.8 выходы 

Parsing sources...
100% [ 1/ 1]  someruby.rb                                                       

Generating Darkfish...

Files:         1
Classes:       1 (    1 undocumented)
Constants:     0 (    0 undocumented)
Modules:       0 (    0 undocumented)
Methods:       3 (    3 undocumented)
  0.00% documented

Elapsed: 0.0s

исходный код непереключение в сгенерированном rdoc.

Rdoc 3.5.3 выходы 

100% [ 1/ 1]  someruby.rb                                                       

Generating Darkfish format into /Users/paul/dev/alesrelated/someruby/doc...

Files:      1

Classes:    1 (1 undocumented)
Modules:    0 (0 undocumented)
Constants:  0 (0 undocumented)
Attributes: 0 (0 undocumented)
Methods:    3 (3 undocumented)

Total:      4 (4 undocumented)
  0.00% documented

Elapsed: 0.1s

исходный код переключает вывод html.

1 Ответ

1 голос
/ 22 мая 2011

Вам нужно добавить комментарии к вашему коду, вы можете попробовать использовать это, например: 

# A description about this class
class Iamaclass
 # A description about this method
 def initialize
    @name = "superclass"
 end

 # Another description about some other method
 def get_name
    @name
 end

 def proud?
    true
 end
end

После этого вы можете попробовать снова запустить команду rdoc.

...