词条 | HeaderDoc |
释义 |
| name = HeaderDoc | logo = | screenshot = | caption = | collapsible = | author = | developer = Apple Inc. | released = September 13, 2000 | latest release version = 8.9 | latest release date = June 8, 2009 | latest preview version = | latest preview date = | programming language = Perl, C (helpers) | operating system = Mac OS X, UNIX, Linux | platform = | language = | status = | genre = Documentation generator | license = Apple Public Source License 2.0 | website = https://developer.apple.com/opensource/tools/headerdoc.html }} HeaderDoc is a documentation generator developed and maintained by Apple Inc. Using specially commented source code files as input, HeaderDoc generates documentation for the code in HTML or XML format. Syntax for HeaderDoc comment tags is largely similar to, and as of HeaderDoc version 8, supportive of Javadoc tags. HeaderDoc 8.7 and later also provides partial support for many Doxygen tags (@ form only, and must conform to HeaderDoc tag ordering rules). Apple's HeaderDoc project is free, open source software distributed under the Apple Public Source License. Supported plain text languages
The HeaderDoc tool set consists of the main utility, headerdoc2html, and gatherheaderdoc. The headerdoc2html tool generates a directory of either HTML (or optionally XML) files from the commented source files specified. Afterwards, the gatherheaderdoc utility may be executed to create a table of contents file for the documentation. Finally, the resolveLinks utility may be used to resolve cross-references between multiple documentation collections. Apple's Xcode development environment contains features designed to assist the process of creating documentation using the HeaderDoc syntax and tools. Additional FeaturesHeaderDoc has the following core features:
The HeaderDoc suite also includes several tools that may be used independently:
See also{{Portal|Free and open-source software}}
External links
1 : Free documentation generators |
随便看 |
|
开放百科全书收录14589846条英语、德语、日语等多语种百科知识,基本涵盖了大多数领域的百科知识,是一部内容自由、开放的电子版国际百科全书。