java - 在 GitHub 上显示 JavaDocs

标签 java github javadoc markdown

我正在寻找一种将 javadocs 从我的开源项目(在 Eclipse 中生成)转换为 GitHub MarkDown 的方法,或者想出一些其他简单的解决方案来在 GitHub 上显示我的文档(害羞于简单地添加一个 docs 目录)。有一个简单的解决方案吗?我可以简单地将 GitHub README.md 指向我的 docs 目录吗?有什么更优雅的吗?我一直在 Google 上大放异彩。

最佳答案

我认为使用 MarkDown 制作可用的 Javadoc 是不可能的。最好的解决方案可能是将您生成的 Javadoc 提交到 gh-pages 分支(或在 docs/ 目录中,具体取决于项目的设置)。它将在以下位置提供:

http://username.github.io/projectname

这是我的一个项目的示例:

http://ebourg.github.io/jsign/apidocs/

关于java - 在 GitHub 上显示 JavaDocs,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/15347808/

相关文章:

java - java从xml中提取字符串

java - 继承指定Type的泛型类时会发生Type Erasure吗?

java - 为什么 Double.valueof javadoc 说它缓存值,而实际上没有?

java - 浏览 Javadoc

Java LinkedList - 检索操作之间的差异

java - Java中如何获取字符串中的特定单词

github - 在 Github 中,如何将更改提交到克隆并提交拉取请求?

git - 克隆后记住多个 git 远程 url

android - 将 GitHub 项目导入 AndroidStudio 未正确显示

java - 字符串 as\x03\x00\x00\x00 转为整数