从javadocs制作一个bitbucket源wiki

时间:2014-03-24 16:30:59

标签: java markdown javadoc bitbucket doclet

您好我正在处理我们用于应用程序的相当大的内部SDK。我配备了大量的Javadocs。现在我的目标是以某种方式从这些javadoc生成.MD文件,以便我可以直接将这些.md文件放入我的bitbucket wiki中。

有没有办法解决这个问题,或者生成bitbucket wiki可以使用的任何其他文件格式?

1 个答案:

答案 0 :(得分:1)

Doxygen似乎support Javadoc-style comments,可以output LaTeX。 LaTeX可以由Pandoc使用,它支持Markdown输出。这有点迂回,但它是我能看到的唯一现实选择。

类似以下内容(未经测试)

# 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。