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

Question

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

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

Thanks

Answer 1

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

alt text http://www.filigris.com/products/docflex_javadoc/images/eclipse_javadoc_1.png

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

Answer 2

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

Superpackages должны приходить в JDK 7, который я считаю, может решить эту проблему: http://blogs.oracle.com/andreas/entry/superpackages_in_jsr_294

Answer 3

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

Если вы используете 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>. Последний не может быть синтаксически спонтанным.