HeaderDoc - это генератор документации, разработанный и поддерживаемый Apple Inc. Используя специально закомментированные файлы исходного кода в качестве входных данных, HeaderDoc генерирует документацию для кода в формате HTML или XML . Синтаксис тегов комментариев HeaderDoc во многом аналогичен и, начиная с версии 8, поддерживает теги Javadoc . HeaderDoc 8.7 и более поздние версии также обеспечивают частичную поддержку многих тегов Doxygen (только форма @ и должны соответствовать правилам упорядочивания тегов HeaderDoc). Проект HeaderDoc Apple , является свободным , открытым источником программного обеспечения , распространяемое под Apple , Public Source License .
Разработчики) | Apple Inc. |
---|---|
Первый выпуск | 13 сентября 2000 г. |
Стабильный выпуск | 8.9 / 8 июня 2009 г. |
Написано в | Perl , C (помощники) |
Операционная система | Mac OS X , UNIX , Linux |
Тип | Генератор документации |
Лицензия | Лицензия Apple Public Source License 2.0 |
Веб-сайт | разработчик |
Поддерживаемые языки обычного текста
- AppleScript
- Баш
- Bourne Shell
- C Shell
- C
- C ++
- Корн Шелл
- Ява
- JavaScript
- Определения Mach MIG [1]
- Цель-C
- Паскаль
- Perl
- PHP
- Python
- Рубин
- Tcl
Набор инструментов HeaderDoc состоит из основной утилиты headerdoc2html и gatherheaderdoc. Инструмент headerdoc2html создает каталог файлов HTML (или, возможно, XML ) из указанных закомментированных исходных файлов. После этого может быть запущена утилита gatherheaderdoc для создания файла оглавления документации. Наконец, утилита resolveLinks может использоваться для разрешения перекрестных ссылок между несколькими коллекциями документации.
Среда разработки Apple Xcode содержит функции, призванные помочь процессу создания документации с использованием синтаксиса и инструментов HeaderDoc.
Дополнительные возможности
HeaderDoc имеет следующие основные функции:
- Предварительная обработка C, позволяющая выбранным пользователем макросам #define изменять содержимое и позволяющая пользователю передавать флаги командной строки для игнорирования частей ввода.
- Подсветка синтаксиса с помощью пользовательских стилей.
- Целевые страницы на основе шаблонов для индексов.
- Кроссплатформенность (написано в основном на Perl).
В комплект HeaderDoc также входит несколько инструментов, которые можно использовать независимо:
- MPGL - набор инструментов, предназначенных для упрощения создания справочных страниц UNIX с использованием упрощенного синтаксиса XML, состоящего из подмножества XHTML плюс тегов разделов, тегов параметров и т. Д. HeaderDoc также предоставляет инструмент связывания, который помогает создавать справочные страницы из комментариев заголовков для функций через режим вывода XML HeaderDoc.
- resolveLinks - инструмент, который позволяет быстро повторно связывать веб-сайт, когда контент перемещается на другой адрес, с помощью встроенных якорей и запросов ссылки.
- filtermacros.pl - инструмент, который можно использовать для фильтрации разделов заголовков на основе макросов препроцессора C. В настоящее время это доступно только при загрузке архива с исходным кодом. Начиная с HeaderDoc 8.9, эта функциональность встроена в сам инструмент headerdoc2html.
Смотрите также
- Сравнение генераторов документации
- Документация по стандартному интерфейсу
Внешние ссылки
- Устаревшая документация: Руководство пользователя HeaderDoc
- http://opensource.apple.com Последняя версия] (в настоящее время 8.9.28)
- Список рассылки HeaderDoc (обычно используется для получения помощи, исправлений и т. Д.)