Как исключить определенный класс / пакеты / открытые члены из javadoc

Question

Я создал java api -портированный из C #, чтобы быть более конкретным - который помимо общедоступного интерфейса содержит много внутренних вещей, о которых я не хочу, чтобы пользователь знал. В C # я использовал doxygen для генерации документации. Я предполагаю, что у javadoc есть подобные особенности, чтобы исключить определенных открытых членов, классы, даже пакеты.

Кто-нибудь подскажет, как это сделать, возможно, с помощью затмения?

Спасибо

Answer 1

Я считаю, что в Eclipse единственным типом исключений, которые вы можете указать, являются такие вещи, как «исключить все защищенные элементы» и исключения на основе пакетов (не исключения на основе классов).

Если вы используете Ant для их генерации, вы можете использовать вложенный элемент "package", а также использовать вложенный элемент набора файлов и добавлять исключения в этот набор файлов.

Например:

<javadoc >
    <sourcefiles>
          <fileset dir="${src}">
              <include name="**/*.java"/>
              <exclude name="**/ClassToExclude.java"/>
          </fileset>
    </sourcefiles>
    <packageset>
          <dirset dir="${src}">
              <include name="com.mydomain.*"/>
              <exclude name="com.mydomain.excludePackage"/>
          </dirset>
     </packageset>
</javadoc>

P.S. - Я использовал элемент <sourcefiles> много, но никогда не использовал элемент <packageset>. Последний может быть синтаксически не точным.

Answer 2

Конечно, когда вы генерируете Javadoc, вы можете выбрать пакет, связанный с этим процессом, и исключить другие

альтернативный текст http://www.filigris.com/products/docflex_javadoc/images/eclipse_javadoc_1.png

(здесь на рисунке показан Javadoc, созданный с помощью другого инструмента, но это не меняет общей идеи)

Answer 3

Вы можете использовать doxygen с Java. Я не знаю ни одного инструмента, который делает то, что вы хотите с Javadoc.

Суперпакеты должны быть в JDK 7, который, как я полагаю, мог бы решить эту проблему: