如何在没有R和BuildConfig的情况下使用Android Studio创建JavaDoc？

时间：2015-03-20 09:01:43

标签： android android-studio javadoc

我想为我的库生成JavaDoc，不包括R和BuildConfig。 Generate JavaDoc...菜单中的Tools功能无法排除文件。

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

4 个答案:

答案 0 :(得分：65)

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

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

  2. 选择Custom scope。没有必要从中选择任何东西     下拉菜单。

  3. 点击...图标打开Scopes对话框。
  4. 使用绿色+图标添加新的自定义范围。给它一个     如果你愿意，可以使用描述性名称。
  5. 在Production Classes（不是Library Classes，因为那些是R.java     导入）导航到您希望为其生成Javadoc的模块，     并选择您要包含的任何单个Java文件。在你的     例如，您可能想要选择整个模块但是     手动排除BuildConfig.java和OK。完成后，单击Specify Generate JavaDoc scope退出“范围”对话框。
  6. 在Custom scope对话框中，如果您的新范围是 未在OK下拉菜单中选中，现在选择它，如 以及任何其他附加选项，包括输出目录。
  7. 最后，点击$('[id^=selectNumber] :selected').each(callback); 生成您的Javadoc。

    8. enter image description here

答案 1 :(得分：25)

接受的答案非常复杂，我有一个更好的答案。

  1. 打开菜单选项工具 - ＆gt; Javadoc中。
  2. 选择自定义范围。然后选择Project Files
  3. 点击OK。

    4. enter image description here

    在这些之后，您将看到R文件和BuildConfig被排除在外。

答案 2 :(得分：4)

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

  1. 在左侧的项目视图中，选择要为其生成文档的根源目录（例如＆＃34; com＆＃34;或＆＃34; org＆＃34;）
  2. 打开JavaDoc生成对话框（工具 - ＆gt;生成JavaDoc ...）
  3. 选择＆＃34;自定义范围＆＃34; （它是我的版本中的第5个单选按钮）并选择您的模块（例如＆＃34;模块＆＃39;库＆＃39;＆＃34;）
  4. 选择您的其他属性，例如输出目录，方法可见性等，然后单击＆＃34;确定＆＃34;

    5. 那就是它。应该在不包含R或BuildConfig文件的情况下生成JavaDoc。

答案 3 :(得分：0)

另一种方法是 一键式工具->生成JavaDoc ... 2-选择自定义范围 3-从下拉菜单中选择打开文件。

此方法将仅为您在ur窗口中打开的文件生成文档

相关问题
最新问题