DocumentationTool — 자바 문서 도구 호출 인터페이스

DocumentationTool — 자바 문서 도구 호출 인터페이스

프로그램에서 자바독(javadoc) 같은 문서 도구를 직접 호출하고 싶을 때가 있어요. DocumentationTool은 그런 자바 언어 문서 도구를 호출하기 위한 인터페이스예요. Tool과 OptionChecker를 확장해요.

소스 파일에서 문서화된 주석을 추출해 HTML 문서를 생성하는 도구를 추상화해요.

출처: Java API Reference

본문

DocumentationTool은 인터페이스로, 주요 메서드는 다음과 같아요.

DocumentationTool.DocumentationTask getTask(Writer out, JavaFileManager fileManager,
    DiagnosticListener<? super JavaFileObject> diagnosticListener,
    StandardJavaFileManager docletClassLoader,
    Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)
  • getTask(...) — 실제 문서 생성을 수행하는 DocumentationTask를 만들어요. 출력, 파일 매니저, 진단 리스너, 닥클렛 로더, 옵션, 소스 파일들을 인자로 받아요.
  • DocumentationTask의 call()을 호출하면 문서 생성이 실행되고 성공 여부가 돌아와요.

ToolProvider.getSystemDocumentationTool()로 시스템 문서 도구 인스턴스를 얻을 수 있어요.

전형적인 사용 패턴은 JavaCompiler과 매우 유사해요. 시스템 문서 도구를 얻고, 표준 파일 매니저를 만들고, 소스 파일 객체들을 넘겨 DocumentationTask를 만든 뒤 call()로 실행하는 식이에요. javax.tools 패키지에 속해요.

더 알아보기 (Learn more)