Záhlaví - HeaderDoc - Wikipedia

Záhlaví
VývojářiApple Inc.
První vydání13. září 2000
Stabilní uvolnění
8.9 / 8. června 2009
NapsánoPerl, C (pomocníci)
Operační systémMac OS X, UNIX, Linux
TypGenerátor dokumentace
LicenceLicence Apple Public Source 2.0
webová stránkavývojář.jablko.com/ opensource/nástroje/ headerdoc.html

Záhlaví je generátor dokumentace vyvinutý a udržovaný společností Apple Inc. HeaderDoc pomocí speciálně komentovaných souborů zdrojového kódu jako vstupu generuje dokumentaci ke kódu v HTML nebo XML formát. Syntaxe značek komentářů HeaderDoc je do značné míry podobná a od verze HeaderDoc 8 podporuje Javadoc značky. HeaderDoc 8.7 a novější také poskytuje částečnou podporu mnoha Doxygen značky (pouze @ formulář a musí odpovídat pravidlům pro řazení značek HeaderDoc). Projekt HeaderDoc společnosti Apple je volný, uvolnit, otevřený zdroj software distribuovaný pod Licence Apple Public Source.

Podporované jazyky prostého textu

Sada nástrojů HeaderDoc se skládá z hlavního nástroje, headerdoc2html a collectheaderdoc. Nástroj headerdoc2html vygeneruje adresář obou HTML (nebo volitelně XML ) určeny soubory z komentovaných zdrojových souborů. Poté může být spuštěn obslužný program collectheaderdoc k vytvoření souboru obsah soubor dokumentace. Nakonec lze nástroj ResolutionLinks použít k vyřešení křížových odkazů mezi více kolekcemi dokumentace.

Apple Xcode vývojové prostředí obsahuje funkce určené k usnadnění procesu vytváření dokumentace pomocí syntaxe a nástrojů HeaderDoc.

Další funkce

HeaderDoc má následující základní funkce:

  • C předzpracování, umožňující uživateli vybrat #define makra ke změně obsahu a umožnit uživateli předat příznaky příkazového řádku k ignorování částí vstupu.
  • Syntaxe zbarvení s uživatelem definovanými styly
  • Šablony vstupních stránek pro indexy.
  • Cross-platform (napsáno většinou v Perlu).

Sada HeaderDoc také obsahuje několik nástrojů, které lze použít samostatně:

  • MPGL —Sada nástrojů určených ke zjednodušení vytváření ručních stránek systému UNIX pomocí odlehčené syntaxe XML skládající se z podmnožiny značek XHTML plus značek sekcí, značek parametrů atd. HeaderDoc také poskytuje přemosťovací nástroj, který pomáhá generovat ruční stránky z komentářů záhlaví pro funkce prostřednictvím Režim výstupu XML souboru HeaderDoc.
  • vyřešitLinky —Nástroj, který umožňuje rychlé nové propojení webových stránek, když se obsah přesune na jinou adresu pomocí vložených kotev a požadavků na odkazy.
  • filtermacros.pl —Nástroj, který lze použít k odfiltrování sekcí záhlaví založených na makrech preprocesoru C. To je aktuálně k dispozici pouze po stažení zdrojového tarballu. Od verze HeaderDoc 8.9 je tato funkce zabudována do samotného nástroje headerdoc2html.

Viz také

externí odkazy