Open main menu
Home
Random
Recent changes
Special pages
Community portal
Preferences
About Wikipedia
Disclaimers
Incubator escapee wiki
Search
User menu
Talk
Dark mode
Contributions
Create account
Log in
Editing
Documentation generator
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{Short description|Automation technology for creating software documentation}} {{refimprove|auto=yes|date=December 2009}} In [[software development]], a '''documentation generator''' is an [[automation]] technology that generates [[software documentation|documentation]]. A generator is often used to generate [[API documentation]] which is generally for [[programmers]] or operational documents (such as a manual) for [[end user]]s. A generator often pulls content from [[source code|source]], [[binary file|binary]] or [[Logging (computing)|log]] files.<ref>{{cite book |last1=Zhang |first1=Sai |last2=Zhang |first2=Cheng |last3=Ernst |first3=Michael |title=2011 26th IEEE/ACM International Conference on Automated Software Engineering (ASE 2011) |chapter=Automated documentation inference to explain failed tests |date=2011 |pages=63β72 |doi=10.1109/ASE.2011.6100145|isbn=978-1-4577-1639-3 |s2cid=14846118 |chapter-url=http://www.cs.washington.edu/homes/mernst/pubs/test-documentation-ase2011.pdf }}</ref> Some generators, such as [[Javadoc]] and [[Doxygen]], use special [[comment (computer programming)|source code comments]] to drive content and formatting. ==See also== * [[Comparison of documentation generators]] * [[Template processor]] * [[Static code analysis]] * [[Literate programming]] * [[Integrated development environment]] ==References== {{refList}} [[Category:Documentation generators| ]] {{Software-type-stub}}
Edit summary
(Briefly describe your changes)
By publishing changes, you agree to the
Terms of Use
, and you irrevocably agree to release your contribution under the
CC BY-SA 4.0 License
and the
GFDL
. You agree that a hyperlink or URL is sufficient attribution under the Creative Commons license.
Cancel
Editing help
(opens in new window)
Pages transcluded onto the current version of this page
(
help
)
:
Template:Cite book
(
edit
)
Template:RefList
(
edit
)
Template:Refimprove
(
edit
)
Template:Short description
(
edit
)
Template:Software-type-stub
(
edit
)