2012-05-18 180 views
2

紅寶石碼DOC這是我的設置:沒有表現出任何文件

  • 的Ruby 1.9.2 P290
  • 堆場0.8.1

的文件夾結構不是寶石,只是普通的老紅寶石代碼:

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

問題是,院子裏沒有看到任何文件。

yard doc產生這樣的輸出:

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

任何想法,爲什麼它不能看到我的任何文件,或不


編輯(附加信息):

Yard有權創建文件。

後,我跑了yard doc命令,我的目錄顯示院子文件:

.  ..  .yardoc classes doc  run.rb 

編輯(響應有關的RDoc評論)

一旦我刪除碼創建文檔的文件夾(的RDoc抱怨吧)rm -rf 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。它的行爲方式與上面描述的相同

+0

當您發出命令,什麼是你的工作目錄? – Phrogz

+0

工作目錄與我的文件所在的位置相同。這與我爲上述示例文件夾結構發佈樹命令時相同。 – wmarbut

+0

當您嘗試使用rdoc而不是院子時會發生什麼?這將有助於三角測量是否僅僅是一個場地問題,還是系統/配置問題。 –

回答

2

Yard不會自動記錄目錄結構中的所有ruby文件。它在./lib目錄中查找文件。如果你想記錄別人,你必須指定的命令或在.yardopts文件

例如 yard classes/*.rb *.rb