Выполнение Eclipse генерировать javadoc из командной строки

Question

У меня есть случай, когда я хотел бы создать javadoc следующим образом.

• Я хотел бы генерировать Javadoc для публичных методов для всего проекта
• Я хотел бы, чтобы сгенерировать Javadoc для защищенных методов одного класса.

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

После прочтения по следующей ссылке

http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#runningjavadoc

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

Мои вопросы заключаются в следующем,

• Есть ли способ запустить стиль Eclipse, инструмент генерации Javadoc из командной строки? Если да, то где я могу найти и пример того, как это сделать.
• Если у вас нет способа сделать это, есть ли способ сказать javadoc-инструменту пройти через каждый пакет и документировать классы в рекурсивно?
• Есть ли способ сообщить инструменту javadoc, какие типы методов для документа, public vs protected vs и т. Д.?

Answer 1

Вы можете позволить eclipse генерировать файл сборки муравьев. Затем вы можете использовать этот файл сборки муравьев из командной строки.

Answer 2

из Javadoc HelpText вы можете использовать эти флаги/параметры:

-public     Show only public classes and members 
-protected    Show protected/public classes and members (default) 
-package     Show package/protected/public classes and members 
-private     Show all classes and members 
-help      Display command line options and exit 
-doclet <class>   Generate output via alternate doclet 
-docletpath <path>  Specify where to find doclet class files 
-sourcepath <pathlist> Specify where to find source files 
-classpath <pathlist>  Specify where to find user class files 
-exclude <pkglist>  Specify a list of packages to exclude 
-subpackages <subpkglist> Specify subpackages to recursively load 

В качестве альтернативы, вы можете использовать инструмент сборки, как муравей или Maven для создания Javadoc для вас, которые имеют хорошие завернутые функции. Вот цель муравья javadoc для одного из моих проектов:

<target name="javadoc" description = "generate javadoc from source"> 
    <delete dir="javadoc" verbose ="true"/> 
    <javadoc packagenames ="my.app.*"    
      sourcepathref = "javadoc.sourcepath" 
      author ="true" 
      destdir = "javadoc" 
      windowtitle = "${project-name} API" 
      linksource= "yes" 
      overview="${src}/overview-summary.html" 
     access="public">      



    </javadoc> 
    </target>