RDoc 모듈

RDoc 모듈

RDoc는 Ruby 소스 파일을 파싱해 클래스·모듈·메서드·include·require의 정의를 추출해서 문서를 만들어 주는 도구예요. 정의 바로 앞에 있는 주석 블록의 선택 문서와 연결한 뒤, 출력 포맷터로 렌더링해요.

출처: Ruby 3.3 API

본문

로드맵 (Roadmap)

  • RDoc에서 버그를 찾았다고 생각되면 CONTRIBUTING의 Bugs 항목을 보세요.
  • Ruby 소스 파일 문서를 만드는 데 RDoc을 쓰고 싶다면 RDoc::Markup을 보고, 명령행 사용법은 rdoc --help를 참고해요.
  • 기본 마크업 형식을 설정하고 싶다면 RDoc::Markup의 Supported Formats를 보세요.
  • gem에 rdoc 설정(예: 기본 마크업 형식)을 저장하고 싶다면 RDoc::Options의 Saved Options를 보세요.
  • Ruby 파일용 문서를 작성하려면 RDoc::Parser::Ruby를 보세요.
  • C로 작성된 확장 문서를 작성하려면 RDoc::Parser::C를 보세요.
  • rake로 문서를 생성하려면 RDoc::Task를 보세요.
  • RDoc을 프로그래밍 방식으로 구동하려면 RDoc::RDoc을 보세요.
  • 텍스트 블록을 HTML이나 다른 형식으로 포맷하는 라이브러리를 쓰려면 RDoc::Markup을 보세요.
  • generator나 directive 핸들러 같은 RDoc 플러그인을 만들려면 RDoc::RDoc을 보세요.
  • 직접 만든 출력 generator를 작성하려면 RDoc::Generator를 보세요.
  • RDoc이 어떻게 동작하는지 전체적으로 보려면 CONTRIBUTING의 Bugs 항목을 참고해요.

크레딧 (Credits)

RDoc은 현재 Eric Hodel <[email protected]>이 유지보수하고 있어요.

Dave Thomas <[email protected]>이 RDoc의 원작자예요.

  • rdoc/parse.rb의 Ruby 파서는 irb와 rtags 패키지의 Ruby 파서를 만든 Nippon Rational Inc의 Keiju ISHITSUKA의 뛰어난 작업에 크게 기반하고 있어요.

상수 (Constants)

  • ATTR_MODIFIERS

Public Class Methods

home ()

설정 디렉터리를 찾아 반환해요.

  • $HOME/.rdoc 디렉터리가 존재하면 그 디렉터리.
  • XDG_DATA_HOME 환경변수가 설정돼 있으면 그 경로 아래의 rdoc 디렉터리.
  • $HOME/.local/share/rdoc 디렉터리.

홈 디렉터리 외에도, 포함 디렉터리는 자동으로 생성돼요.

load_yaml ()

사용 가능한 최선의 YAML 라이브러리를 불러와요.