logo标签列表

从Javadocs创建一个Bitbucket源代码Wiki

javamarkdownjavadocbitbucketdoclet
8

你好，我正在开发一个我们应用程序所使用的相当大的内部SDK。我已经为其配备了丰富的Javadocs文档。现在我的目标是以某种方式从这些javadocs生成.MD文件，使我能够直接将这些.md文件放入我的bitbucket wiki。

是否有一种方法可以实现这个目标或者生成任何其他Bitbucket Wiki支持的文件格式？

1个回答
1

Doxygen似乎支持Javadoc风格的注释并且可以输出LaTeX。LaTeX可以被Pandoc所使用，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。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接