Posts Tagged ‘AurigaDoclet’
Eclipse에서 javadoc을 pdf로 출력하기
www.doclet.com에 소개된 바와 같이 여러 종류의 doclet이 있으나, 그 중 몇몇은 javaodc의 출력 형태를 pdf로 직접 지정할 수 있다.
LaTex를 쓰는 방법은 LaTex의 특성상 가독성이 좋은 결과물을 만들 것으로 기대되나,
별도로 변환을 한번 더 해줘야 하는 번거로움이 있으므로 이왕이면 손이 덜 가는 방법을 찾아보게 되었다.
www.doclet.com에 소개된 library 중 하나인,
AurigaDoclet(http://aurigadoclet.sourceforge.net/)을 사용해 보자.
사용법은 간단하다.
ANT에서 지정할 수 있는 설정은,
<javadoc packagenames=”package-names”
sourcepath=”source-path”
doclet=”com.aurigalogic.doclet.core.Doclet”
docletpath=”aurigadoclet-path”
additionalparam=”options”
>
<classpath refid=”aurigadoclet.class.path” />
</javadoc>
package-names package names source-path path of the java source files aurigadoclet-path path to the AurigaDoclet.jar file in AurigaDoclet’s bin directory options AurigaDoclet options.
이며, 이 때 사용할 수 있는 옵션으로
-format
- The output format.
Supported values: fo,pdf,ps,pcl,svg.
- -out
- Output file path.
- -notoc
- Do not generate TOC page.
- -nonavigation
- Do not generate navigation tree.
- -nolinks
- Do not use hyperlinks.
- -noindex
- Do not generate a keyword index.
- -leftmargin
- Left margin in points. Default is 30.
- -rightmargin
- Right margin in points. Default is 30.
- -topmargin
- Top margin in points. Default is 10.
- -bottommargin
- Bottom margin in points. Default is 10.
- -headertext
- XHTML text to be used as page header.
- -headerfile
- XHTML file to be used as page header.
- -footertext
- XHTML text to be used as page footer.
- -footerfile
- XHTML file to be used as page footer.
- -headerheight
- Height of page headers in points. Default is 50.
- -footerheight
- Height of page footer in points. Default is 20.
- -coverfile
- XHTML file to be used a cover page.
- -cssfile
- CSS file to used for formatting the output.
Default css file is located in src/com/aurigalogic/doclet/resources/default.css
- -xslfile
- Custom xsl file to be used for formatting the output.
가 있다.
따라서, Eclipse에서 이 정보를 활용하여, aurigadoclet을 사용하도록 환경설정하고
실행시 옵션으로 위의 옵션을 택하여 지정하면 된다.
1. Eclipse의 해당 프로젝트로부터, Export > JavaDoc > Use custom doclet 선택
2. Docletname에 com.aurigalogic.doclet.core.Doclet 을
3. Doclet class path에 설치한디렉토리binAurigaDoclet.jar 를 써준다.
Next를 누른다.
4. Extra Javadoc options에
-format pdf -out “만들 pdf의 경로와 이름” 을 적어주고,
Finish 누르면 pdf가 생성된다.