Вопрос

Это моя настройка:

    .
  • ruby 1.9.2 p290
  • двор 0.8.1

    Структура папки не является драгоценным камнем, просто простным старым кодом RUBY:

    .
    ├── classes
    │   ├── crawl.rb
    │   └── page.rb
    └── run.rb
    
    .

    Проблема в том, что двор не видит никаких файлов.

    GeneracodicCode дает этот выход:

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

    Любые идеи, почему это не может видеть никаких моих файлов, либо не


    Редактировать (дополнительная информация): У

    Двор имеет разрешения для создания файлов.

    После запуска команды yard doc, мой каталог показывает файлы двора:

    .       ..      .yardoc classes doc     run.rb
    
    .


    Редактировать (ответ на комментарий о RDOC)

    Как только я удаляю папку DOC, который создает двор (RDOC жалуется на него) yard doc, RDOC генерирует документацию и обеспечивает этот выход

     Files:       7
    
     Classes:     6 ( 4 undocumented)
     Modules:     0 ( 0 undocumented)
     Constants:   2 ( 2 undocumented)
     Attributes: 18 (18 undocumented)
     Methods:    24 (20 undocumented)
    
     Total:      50 (44 undocumented)
      12.00% documented
    
    .


    Редактировать (дополнительная информация)

    двор не работает для меня на других рубиновых сборках, включая MRI 1.8.7 и Jruby 1.6.4.Ведет себя так же, как описано выше

Это было полезно?

Решение

двор не документирует все рубиновые файлы в структуре каталогов.Он ищет файлы в каталоге ./lib.Если вы хотите документировать другие, вы должны указать, что в команде или в файле .yardopts

Пример yard classes/*.rb *.rb

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top