Как я могу создать свой JAR-файл, чтобы пользователи, которые используют библиотеку, могли видеть Javadoc в Eclipse?

Question

Я работаю над небольшой библиотекой для использования в нашей компании и тщательно документирую ее. Сейчас я строю свою банку с помощью следующего кода:

<project name="commonutils" default="compile" basedir="."> 

    <property name="src" location="src" />

    <property name="build" location="buildDirecotry" />

    <target name="compile">
        <delete file="${ant.project.name}.jar" />
        <mkdir dir="${build}"/>
        <javac srcdir="${src}" destdir="${build}" debug="on" target="1.5">
            <classpath>
                <pathelement location="lib/build/server.zip" />
                <pathelement path="${java.class.path}/"/>
            </classpath>
        </javac>
        <jar basedir="${build}" destfile="${ant.project.name}.jar" />
        <delete dir="${build}" />
    </target>

</project>

Это прекрасно работает, он создает мой jar-файл со всеми файлами src, но когда я включаю jar-файл в другой проект, у меня больше нет ни одного из моих комментариев javadoc. Используя JDDecompiler, я не могу видеть комментарии в файле классов, хотя я не уверен, что это компилятор java, который их обрабатывает, или JD.

У меня вопрос: как я могу создать свой jar-файл, чтобы пользователи, которые используют библиотеку, могли видеть javadoc в Eclipse.

Answer 1

Если вы включите исходные файлы в jar (каждый класс и java-файл находятся в одном каталоге-пакета), он должен работать.

<target name="jar.noCompile.src">  
    <jar destfile="${ant.project.name}.jar">  
      <fileset dir="${build}"/>  
      <fileset dir="${src}" includes="**/*.java"/>  
    </jar>  
</target>  

Answer 2

AFAIK документация является функцией Eclipse. Вы должны настроить это вручную. В вашей сборке сгенерируйте документацию (обычно в папку 'javadoc') и упакуйте ее с JAR. Когда кто-то захочет использовать вашу библиотеку, он / она должен перейти в библиотеки выбора пути Java, добавить свои, щелкнуть рядом с ним, чтобы открыть узел дерева, а затем дважды щелкнуть местоположение Javadoc, чтобы настроить его.