Почему javadoc может не создать страницу для определенного класса?
У меня есть проект с несколькими пакетами и классами.
При запуске javadoc против проекта (с использованием задачи Apache ant) я считаю, что каждый класс документируется Кроме для того, над которым я сейчас работаю.
Класс не отображается во фрейме «Все классы». Класс не отображается ни в одном из фреймов «Пакет». На диске нет файлов с тем же именем, что и у класса (что, конечно, есть у всех других классов).
Некоторые вещи я проверил:
Другие классы в том же пакете документируются, поэтому этот класс не «исключается» из-за своего пакета.
Это класс
public, поэтому он не скрывается из-за проблем с видимостью.Исходный файл действительно содержит правильные комментарии в стиле javadoc
/**на уровне класса, а также для некоторых конструкторов и методов-членов.При запуске
javadoc -verboseя вижу, что загружается исходный файл:[javadoc] [parsing started RegularFileObject[/full/path/to/Source.java]] [javadoc] [parsing completed 6ms]Для этого класса ошибок не возникает (есть предупреждения и ошибки для других исходных файлов, но не для этого).
У меня не закончилось место на диске.
Есть идеи, как получить дополнительную информацию от javadoc или понять, почему этот класс можно игнорировать?
Ответы 2
Извините, у меня недостаточно репутации, чтобы оставить комментарий. Вы пробовали использовать функцию Netbeans «Анализировать javadoc»? Он проходит через весь проект и показывает, где что-то может быть не так, и даже предлагает исправления. Его можно найти на
Tools >> Analyze javadoc
когда у вас выбран проект.
РЕДАКТИРОВАТЬ
Есть ли у вас какие-либо общедоступные методы внутри класса, которые не комментируются для javadoc? В противном случае он может не распознать, что класс необходимо добавить в документацию, поскольку там ничего нет.
Есть ли внутри класса хотя бы одна задокументированная «вещь», будь то метод или переменная?
См. Пункт № 3 в моем первоначальном вопросе.
Оказывается, это была глупая ошибка поверх глупой ошибки.
Настоящая проблема заключалась в том, что я передавал в javadoc недопустимый аргумент, который был немного скрыт из-за того, что я использовал Apache Ant:
javadoc -source '${src.spec}' ...
Мой сценарий сборки на основе муравьев добавлял это недопустимое значение -source в командную строку. Javadoc делал движения, но на самом деле не генерирует никаких файлов. Также не выдает никаких ошибок в этом отношении. :(
Вторая проблема заключалась в том, что целью clean в моем сценарии сборки было нет, удаляющее старые файлы javadoc, поэтому запуск ant clean javadoc ничего не менял на диске. Повторная загрузка «сгенерированного» javadoc на самом деле была просто просмотром документов API, которые были созданы давно. Мой новый класс не участвовал в этом забеге, поэтому он не появлялся.
Исправив аргумент -source для javadoc, все снова заработало.
У меня нет доступа к банкомату NetBeans. У меня есть недокументированные общедоступные методы, но это, похоже, не мешает другим классам быть javadoc'd.