如何在生成的API文档中为每个类使用不同的URL?

时间:2019-05-16 20:56:14

标签: javadoc github-pages

我已经在Github页面上托管了我的项目生成的API文档,它非常好用和简单。但是,我也想链接到我网站上特定类的文档。我注意到默认的实现是在整个文档中使用相同的URL,这使得无法链接到任何特定的东西。

作为示例,请查看Google Guava's API docs。无论您单击多少,URL都保持不变。具体地说,这使得无法链接到Lists类。通过javadocs或Github页面中的选项可以做到这一点吗?

1 个答案:

答案 0 :(得分:1)

单击顶部栏正下方的No Frames按钮。在这种模式下,您的网址将根据您访问的页面而改变。然后,您可以复制该链接并将其包含在您自己的文档中。 (https://google.github.io/guava/releases/snapshot-jre/api/docs/com/google/common/collect/Lists.html)。

一旦在页面上,您还可以返回框架模式,URL中docs/之后的所有内容都将变为查询字符串。对于链接,我认为最好使用不带框架的链接。