Интерфейс Taglet

public interface Taglet

Интерфейс для пользовательского taglet, поддерживаемого doclet, такого как standard doclet. Пользовательские taglet используются для обработки пользовательских тегов в комментариях документации; пользовательские теги могут быть созданы индивидуально как теги блоков, которые появляются в конце комментария, или встроенные теги, которые могут появляться внутри основного текста комментария документации.

Каждая реализация taglet должна предоставлять публичный конструктор без аргументов, который будет использоваться doclet для создания экземпляра taglet. Doclet будет взаимодействовать с классами, реализующими этот интерфейс, следующим образом:

1. Doclet создаст экземпляр taglet, используя конструктор без аргументов класса taglet.
2. Далее, doclet вызывает метод init с соответствующей средой и doclet.
3. После этого, doclet вызывает getName, getAllowedLocations и isInlineTag, чтобы определить характеристики тегов, поддерживаемых taglet.
4. По мере необходимости, doclet вызывает метод toString объекта taglet, передавая ему список тегов и элемент, к которому относятся теги в комментарии документации элемента, чтобы taglet мог определить строку, которая должна быть включена в документацию. Doclet обычно указывает любые требования к содержанию возвращаемой строки.

Если объект taglet создается и используется без соблюдения вышеуказанного протокола, поведение taglet не определяется этим интерфейсом.