如何使用Android Studio创build没有R和BuildConfig的JavaDoc？

我想为我的库生成JavaDoc，不包括R和BuildConfig。 “ Tools菜单中的“ Generate JavaDoc...function不具有排除文件的选项。

如何使用Android Studio创build没有R和BuildConfig的JavaDoc？

Answer 1

RocketSpock的答案几乎就在那里，但并不完全（截至撰写本文）。 我现在还不能发表评论，所以我将介绍一下我在Android Studio 1.2.2中从Android库Javadoc中排除R.java和BuildConfig.java的过程。 基本上有一个额外的对话，将非常方便：

1. 打开菜单选项Tools --> Javadoc 。

2. selectCustom scope 。 没有必要从下拉菜单中select任何东西。

3. 单击...图标打开“ Scopes对话框。
4. 用绿色+图标添加一个新的自定义范围。 如果你愿意的话，给它一个描述性的名字。
5. 在Production Classes （不是Library Classes ，因为这些是导入）导航到您希望生成Javadoc的模块，并select您希望包含的任何单个Java文件。 在你的情况下，你可能想要select一个完整的模块，但手动排除R.java和BuildConfig.java 。 完成后，单击OK退出“范围”对话框。
6. 在“ Specify Generate JavaDoc scope对话框中，如果未在“ Custom scope下拉菜单中select新作用域，请立即将其选中，以及其他任何其他选项（包括输出目录）。
7. 最后，点击OK来生成你的Javadoc。

Answer 2

接受的答案是相当复杂的，我有一个更好的。

1. 打开菜单选项Tools – > Javadoc。
2. select自定义范围。 然后selectProject Files
3. 点击OK 。

之后你会看到R文件和BuildConfig被排除在外。

Answer 3

如果要排除生成的文件（R，BuildConfig等），则可以为JavaDoc生成指定自定义作用域。 为了正确的工作，您需要：

1. 在左侧的项目视图中，select根源目录以生成文档（例如“com”或“org”）
2. 打开JavaDoc生成对话框（工具 – >生成JavaDoc …）
3. select“自定义范围”（这是我的版本中的第5个单选button）并select你的模块（例如“模块库”）
4. select你的其他属性，如输出目录，方法可见性等，然后单击“确定”

而已。 您的JavaDocs应该在没有包含R或BuildConfig文件的情况下生成。