Этот документ описывает изменения, произведенные в инструменте Javadoc между версиями 1.4.1 и 1.4.2.
Упомянутые ниже изменения включают число ошибки и была ли фиксация во фронтэнде инструмента Javadoc ("инструмент") или стандарт doclet ("stddoclet"). Термин "регресс" появляется для функций, которые возвращались в некоторый момент - для функций, которые работали в 1.3.x, ворвались 1.4.0 или 1.4.1, и были фиксированы в 1.4.2.
Все известные ошибки, связанные с Разделом американского правительства 508 требований для доступности, были исправлены в этой версии. (4737558, stddoclet)
Включайте serialVersionUID в Сериализированную Форму (4525039, stddoclet)
Может теперь наследовать комментарии от исходных файлов, не задокументированных. Ваш код может автоматически наследовать комментарии от интерфейсов и классов, исходные файлы которых находятся на-sourcepath, но не передаются в на командной строке. Например, для J2SE, можно сделать это, разархивировав src.zip файл, который поставляет с SDK (который не содержит все исходные файлы, однако), и добавьте его путь к-sourcepath. Когда javadoc будет работать на Вашем коде, он загрузит комментарии документа из тех исходных файлов как необходимый. Например, если class в Вашем коде реализует java.lang. Сопоставимый, compareTo(Object) метод, который Вы реализуете, наследует комментарий документа от java.lang. Сопоставимый. Эта функция была фактически доступна в 1.4.1. (Никакое число ошибки, инструмент)
При использовании -link (или -linkoffline) опция, все @see и {@link} теги теперь создают ссылки к исключенным классам. Эта фиксация значительно упрощает возможность соединиться с внешними классами и элементами. Ранее, внешний class должен был быть или импортирован или полностью определен в объявлении для @see или {@link} соединяться с его документацией. Теперь, единственные требования - то, что class полностью определяется и что его документы API появляются на пути, предоставленном -link. (4652655, stddoclet)
Другие новые функции упоминаются ниже.
Известные Исправления ошибок
Ссылки: Фиксированный @link полностью определенного элемента программы, чтобы соединиться с внешними классами с -link опция. (4652655, инструмент, РЕГРЕСС)
Ссылки: Закрепленные недостающие внутренние ссылки по возврату/параметру вводят, когда.java файлы являются passd в (4628281, инструмент)
Выполнение: Фиксированный, таким образом, двойные классы документируются (4673477, инструмент, РЕГРЕСС)
Сериализированная форма: Фиксированные привязки ссылки к классам в сериализированной форме (4521661, stddoclet)
Javascript: Internet Explorer Javascript загружает ошибку когда соединено-linkoffline (4645058, stddoclet, РЕГРЕСС)
HTML: Фиксированный, таким образом, нет никакой разности, передавая на имена пакета или.java имена файлов (4506980, stddoclet)
Javadoc зависает без любого полезного сообщения, если {@inheritDoc} используется в элементе, который не может наследовать комментарий. (4812240, stddoclet) Например:
public class C {
/** {@inheritDoc} */
public abstract void m() {
}
}
Internet Explorer выводит на экран ненужную горизонтальную полосу прокрутки в области основного содержания, когда фреймы показывают. Простое обходное решение описывается в отчете об ошибках. (4852280, stddoclet)
Новые Функции и Исправления ошибок
Все новые функции и исправления ошибок в 1.4.2 следуют.
Параметры командной строки
Новая функция: Добавленная-packagesheader опция для верхнего левого фрейма (4766385, stddoclet)
Новая функция: Включите "-имя тега" ярлык для "-тегирует name:a:name" (4695326, stddoclet)
Новая функция: Добавленная-linksourcetab опция, чтобы преобразовать каждую вкладку в пробелы n. Эта опция экспериментальна и может измениться. (4510979, stddoclet)
Новая функция: - опция тега теперь позволяет тире (-) разделитель для тегов xdoclet как @ejb:bean (4750173, stddoclet)
Новая функция: Новый - опция ключевых слов добавляет имена элемента как meta теги ключевого слова, чтобы улучшить поиск API (4764726, stddoclet)
Новая функция: Добавленные-Xwerror отмечают, чтобы выйти ненулевой, если есть предупреждения. (4099527, инструмент)
Исправление ошибки: опция Fixed - тегирует tagname:X:taghead, таким образом, это больше не требует taghead (4628181, stddoclet)
Исправление ошибки: Задокументированный - подавляют шумы опции, чтобы подавить шумы только стандарта doclet сообщения (4714350, stddoclet). Открытый новая ошибка 4702454, чтобы запросить, чтобы это подавило шумы javadoc сообщений инструмента также.
Исправление ошибки: Перемещенная документация для - исходная опция от doclet опций до javadoc опций инструмента - это всегда была опция инструмента (4760924, stddoclet)
Теги
Новая функция: Javadoc теперь наследовал комментарии @throws для исключений на этапе выполнения (4679573, stddoclet)
Новая функция: Javadoc теперь предупреждает, когда первым параметром @param не является название параметра (4693440, stddoclet)
Исправление ошибки: Теперь сравнивает полностью определенные имена исключения, наследовавшись @throws текст (4684827, stddoclet)
Исправление ошибки: Фиксированный недостающий заголовок 'Бросков' когда сопровождающийся только автоматически сгенерированными исключениями (4530727, stddoclet)
Новая функция: Теперь включает serialVersionUID в Сериализированную Форму (4525039 stddoclet)
Новая функция: Может теперь наследовать комментарии от исходных файлов, не задокументированных. Ваш код может автоматически наследовать комментарии от интерфейсов и классов, исходные файлы которых находятся на-sourcepath, но не передаются в на командной строке. См. пример. (Никакое число ошибки, инструмент)
Исправление ошибки: Фиксированные без вести пропавшие наследованные вложенные классы из сводной таблицы (4638588, stddoclet)
Исправление ошибки: Фиксированный так javadoc больше неправильно перечисляет скрытые поля (4492178, stddoclet)
Исправление ошибки: Добавленный сериализуемый суперкласс непубличного сериализуемого class (4671694, stddoclet)
Исправление ошибки: Больше переопределение документов закрытого метода, такого как createBufferStrategy (4634891, stddoclet)
HTML & Javascript
Новая функция: Теперь включает javadoc номер версии, и создайте в сгенерированном комментарии HTML (4749707, stddoclet)
Исправление ошибки: Добавленный "#anchor" называет назад к ссылкам, которые указывают на классы в сериализированной странице формы (4521661, stddoclet, РЕГРЕСС)
Исправление ошибки: Фиксированное окно title, чтобы не измениться, загружаясь оставленный фреймы (javascript, stddoclet) (4747738, stddoclet)
Недопустимый HTML
Исправление ошибки: Добавленный недостающий пробел в объявлении DOCTYPE (4625400, stddoclet)
Исправление ошибки: Фиксированный недопустимый HTML в frameset DTD и дополнительный <DL> (4275630, stddoclet)
Исправление ошибки: Фиксированный <NOFRAMES>, который не позволяется снаружи <FRAMESET> элемент (4753048, stddoclet)
Исправление ошибки: Фиксированный неправильно! DOCTYPE в index-all.html файле (4418115, stddoclet)
Исправление ошибки: Фиксированные теги HTML-таблицы, которые были вставлены в неправильное место в странице использования пакета (4415270, stddoclet)
Ссылки
Исправление ошибки: Внутренние ссылки, отсутствующие в return/param, вводят когда.java файлы passd в (4628281, инструмент, РЕГРЕСС)
Исправление ошибки: Фиксированный @link полностью определенного элемента программы, чтобы соединиться с внешними классами с -link опция (4652655, инструмент, РЕГРЕСС)
Исправление ошибки: Фиксированный - ссылка и-linkoffline, чтобы создать надлежащие относительные ссылки (4720957, stddoclet)
Исправление ошибки:-linksource опция больше не производит '\' в ссылках когда работавший Windows (4511110, stddoclet)
Исправление ошибки: метка в {@link java.lang метка} больше не игнорируется, соединяясь с именем пакета (4524136, stddoclet)
Исправление ошибки: @link не тегируют больше уродливый, когда только новая строка существует между первыми и вторыми параметрами (4739870, stddoclet)
Выполнение Javadoc
Исправление ошибки: Больше катастрофические отказы, когда тестовый файл неназванного пакета был включен в исходный каталог (4670772, инструмент)
Исправление ошибки: Фиксированный, таким образом, двойные классы еще раз документируются (4673477, инструмент, РЕГРЕСС)
Исправление ошибки: Пустой jarfile на пути к классу: Фиксированный, таким образом, пустой jarfile в пути к классу больше не выдает исключение (4697113, stddoclet)
Исправление ошибки: Файлы: Когда источник и целевые каталоги являются тем же самым, файлы документа больше не повреждаются (4258405, stddoclet)
Ошибка/Предупреждающие сообщения
Исправление ошибки: Улучшите бесполезное сообщение об ошибке "foo.jar: тег Тела, отсутствующий в HTML" (4691095, stddoclet)
Исправление ошибки: Фиксированный так javadoc больше не сообщает об ошибках, когда файлы фляги пути к классу содержат package.html файлы (4697040, stddoclet)