2016-12-30 2 views
1

Я пытаюсь создать некоторый javadoc через ant для небольшого testproject, но я действительно не понимаю все его поведение. Кажется, что многие методы в моем основном классе не учтены, и я действительно не понимаю, почему.Почему javadoc через ant покажет часть документа моего метода?

Вот пример:

/** 
* Diese Methode deligiert die Ausfuehrung der zustandsabhaengigen Aktion an die entsprechende Methode 
* des Zustandsobjektes weiter, welches gerade in der Objektvariable zustand gespeichert ist. 
* @see SetMinutes 
* @see SetHours 
* @see DisplayTime 
*/ 
void inc(){ 
    zustand = zustand.inc(this); 
} 

Это один не показан. Мой муравей цель выглядит следующим образом:

<target name="doc" depends="generateJar"> 
    <javadoc destdir="${doc.dir}"> 
      <fileset dir="."/> 
    </javadoc> 
</target> 

В настоящее время показано только методами являются основным методом (который документально), и способом запуска() (пусто). Меня удивляет также то, что моя документация для методов в других классах проекта генерируется правильно, и я не вижу разницы. (У меня проблемы с генерированием сводки полей тоже, но это, вероятно, материал для другого вопроса, не так ли?)

Любая помощь будет оценена.

ответ

2

По умолчанию javadoc параметр командной строки - -protected, который генерирует только public и protected методов.

Для получения приватных частных процедур (как inc()) необходимо указать -package или -private.

Oracle Документация: http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDCIFFD

+0

Спасибо за ваш быстрый ответ, с вашей помощью я смог выяснить, что делать! – Wolfone

0

EDITED: чтобы соответствовать Stefan Bodewigs комментарий.

С намеком Джима Гаррисона я смог выяснить решение, которое выглядит следующим образом (я также подвести итоги того, что уже было сказано, чтобы иметь все в одном посте):

  • по умолчанию параметр командной строки из javadoc is -protected, который не будет генерировать javadoc для частных и пакетов частных полей и методов
  • , если вы хотите автоматизировать это через ant, мы можем использовать package = "true" (или private = "true", если хотите включая эти поля и методы)

Пример:

<target name="doc" depends="generateJar"> <!--default option für javadoc ist -protected (siehe Web) daher fliegen im default package private methoden raus aus der doc--> 
    <javadoc destdir="${doc.dir}" package="true"> 
      <fileset dir="."/> 
    </javadoc> 
</target> 
+1

На самом деле вы не хотите использовать 'extraparam', а скорее' package = "true" '. –

+0

Спасибо, что добавили! Я изменю свой ответ, чтобы соответствовать этому! – Wolfone

+0

Спасибо, выглядит намного лучше. –

Смежные вопросы