루비 마당 문서가 파일을 보여주지 않습니다

StackOverflow https://stackoverflow.com//questions/10656142

  •  11-12-2019
  •  | 
  •  

문제

이 설정입니다.

  • 루비 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 doc 명령을 실행하면 내 디렉토리가 야드 파일이 표시됩니다. 

    .       ..      .yardoc classes doc     run.rb
    .

    편집 (RDOC에 대한 의견에 대한 응답)

    야드가 생성하는 DOC 폴더를 삭제하면 (RDOC는 IT에 대해 불평합니다) 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를 포함한 다른 루비 빌드에서 나에게 작동하지 않습니다.위에서 설명한 것과 동일한 방식으로 작동합니다

도움이 되었습니까?

해결책

마당은 디렉토리 구조에 모든 루비 파일을 자동으로 문서화하지 않습니다../lib 디렉토리의 파일을 찾습니다.기타 문서를 문서화하려면 명령 또는 .yardopts 파일 에 지정해야합니다.

예제 yard classes/*.rb *.rb

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top