java - javadocs から bitbucket ソース wiki を作成する

Question

こんにちは、アプリに使用するかなり大きな内部 SDK に取り組んでいます。私は広範なJavadocを装備しています。私の目標は、これらの javadocs から何らかの方法で .MD ファイルを生成して、これらの .md ファイルを直接 bitbucket wiki に配置できるようにすることです。

これを行う方法、または bitbucket wiki で使用できる他のファイル形式を生成する方法はありますか?

Answer 1

DoxygenはJavadoc スタイルのコメントをサポートしているようで、 LaTeX を出力できます。LaTeX は、Markdown 出力をサポートするPandocで使用できます。これはやや遠回りですが、私が見ることができる唯一の現実的な選択肢です。

次のようなもの（未テスト）

# Generate a Doxygen configuration file, which
# should enable LaTeX output by default
doxygen -g

# Generate LaTeX documentation in the latex/ directory
doxygen

# Generate one Markdown file for each LaTeX file
find latex/ -name '*.tex' -exec mkdir -p markdown/`dirname {}` && \
    pandoc -o markdown/`basename {} .pdf`.md {} \;

あなたを近づけるはずです。

別の方法として、Javadoc で生成された HTML を取り、それを Pandoc で取り込み、Markdown を出力することもできます。