|
Comparison Of Documentation Generators
The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. Note that many of the generators listed are no longer maintained. General information Basic general information about the generators, including: creator or company, license, and price. Supported formats The output formats the generators can write. Other features See also * Code readability * Documentation generator * Literate programming * Self-documenting code Notes References {{DEFAULTSORT:Comparison Of Documentation Generators Documentation generators Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Documentation Generator
A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods. Types of generation Document generation can be divided in several types: * Batch generation (generic technique) * Text block correspondence (documents created based on pre-defined text blocks) * Forms (forms for websites) * Documentation synthesis: ** Documentation can be inferred from code ** Documentation can be inferred from execution traces ** Documentation can be inferred from mailing lists Some integrated development environments provide interactive access to documentation, code metadata, etc. References See also * Comparison of documentation generators * Template processor * Static c ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Javadoc
Javadoc (originally cased JavaDoc) is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to hyperlink related documents together. The "doc comments" format used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs, like IntelliJ IDEA, NetBeans and Eclipse, automatically generate Javadoc templates. Many file editors assist the user in producing Javadoc source and use the Javadoc info as internal references for the programmer. Javadoc also provides an API for creating doclets and taglets, which allows users to analyze the structure of a Java application. This is how JDiff can generate reports of what changed between two versions of an API. Javadoc does not affect performance in Java as all comments are removed at compilation time. Writing comments and Javado ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Pydoc
Pydoc is the standard documentation module for the programming language Python. Similar to the functionality of Perldoc within Perl and Javadoc within Java, Pydoc allows Python programmers to access Python's documentation help files, generate text and HTML pages with documentation specifics, and find the appropriate module for a particular job. Pydoc can be accessed from a module-specific GUI, from within the Python interpreter, or from a command line shell. Developed by Ka-Ping Yee, it is included by default in all versions of Python since Python 2.1 and is available for download for 1.5.2, 1.6, and 2.0. Pydoc is used to extract documentation from the source code itself. More comprehensive documentation is generated from external reStructuredText documents using the Sphinx documentation system. See also *Comparison of documentation generators The following tables compare general and technical information for a number of documentation generators. Please see the individual pr ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
GNU Lesser General Public License
The GNU Lesser General Public License (LGPL) is a free-software license published by the Free Software Foundation (FSF). The license allows developers and companies to use and integrate a software component released under the LGPL into their own (even proprietary) software without being required by the terms of a strong copyleft license to release the source code of their own components. However, any developer who modifies an LGPL-covered component is required to make their modified version available under the same LGPL license. For proprietary software, code under the LGPL is usually used in the form of a shared library, so that there is a clear separation between the proprietary and LGPL components. The LGPL is primarily used for software libraries, although it is also used by some stand-alone applications. The LGPL was developed as a compromise between the strong copyleft of the GNU General Public License (GPL) and more permissive licenses such as the BSD licenses and the MIT L ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
PhpDocumentor
phpDocumentor is an open-source documentation generator written in PHP. It automatically parses PHP source code and produces readable API and source code documentation, based on PHPDoc-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural code. phpDocumentor runs at the command line to create documentation in HTML format. It has support for linking between documentation, incorporating user level documents like tutorials, and creation of highlighted source code with cross referencing to PHP general documentation. phpDocumentor 1.x could parse PHP syntax of PHP 4 up to PHP 5.2. In March 2012, the DocBlox project merged with the 1.x branch of phpDocumentor, resulting in the new major version release of phpDocumentor 2. The first alpha was released on March 16, 2012. phpDocumentor 2.x supported syntax for PHP 5.3 up to 7.0. The 3.0 major version release occurred on October 27, 2020. This brought PHP sy ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Artistic License
Artistic license (alongside more contextually-specific derivative terms such as poetic license, historical license, dramatic license, and narrative license) refers to deviation from fact or form for artistic purposes. It can include the alteration of grammar or language, or the rewording of pre-existing text. History The artistic license may also refer to the ability of an artist to apply smaller distortions, such as a poet ignoring some of the minor requirements of grammar for poetic effect. For example, Mark Antony's "Friends, Romans, Countrymen, lend me your ears" from Shakespeare's ''Julius Caesar'' would technically require the word "and" before "countrymen", but the conjunction "and" is omitted to preserve the rhythm of iambic pentameter (the resulting conjunction is called an asyndetic tricolon). Conversely, on the next line, the end of "I come to bury Caesar, not to praise him" has an extra syllable because omitting the word "him" would make the sentence unclear, but ad ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Larry Wall
Larry Arnold Wall (born September 27, 1954) is an American computer programmer and author. He created the Perl programming language. Personal life Wall grew up in Los Angeles and then Bremerton, Washington, before starting higher education at Seattle Pacific University in 1976, majoring in chemistry and music and later pre-medicine with a hiatus of several years working in the university's computing center before graduating with a bachelor's degree in Natural and Artificial Languages. While in graduate school at the University of California, Berkeley, Wall and his wife were studying linguistics with the intention of finding an unwritten language, perhaps in Africa, and creating a writing system for it. They would then use this new writing system to translate various texts into the language, among them the Bible. Due to health reasons these plans were cancelled, and they remained in the United States, where Wall instead joined the NASA Jet Propulsion Laboratory after he finishe ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Plain Old Documentation
Plain Old Documentation (pod) is a lightweight markup language used to document the Perl programming language as well as Perl modules and programs. Design Pod is designed to be a simple, clean language with just enough syntax to be useful. It purposefully does not include mechanisms for fonts, images, colors or tables. Some of its goals are: * Easy to parse * Easy to convert to other formats, such as XML, TeX or Markdown * Easy to incorporate sample code * Easy to read without a pod formatter (i.e. in its source-code form) * Easy to write in An extended version of pod that supports tables and footnotes called PseudoPOD has been used by O'Reilly & Associates to produce several Perl books, most notably ''Programming Perl'' by Larry Wall, Tom Christiansen, and Jon Orwant. Pod makes it easy to write manual pages, which are well suited to user-oriented documents. In contrast, other documentation systems, such as Python's Docstring or Java's Javadoc, though they can be used for user ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Pdoc
Pdoc is a software package for generating API documentation for Python programming language. Built as a successor to Epydoc, Pdoc uses introspection to extract documentation from source code docstrings and allows programmers to generate HTML documentation for chosen Python modules. It is thus functionally similar to Pydoc, Perldoc and Javadoc. It supports identifier cross-linking and Markdown for its doc string format. Forks A lack of original project activity in 2018-2019 spurred several forks, such apdoc3anpdocs part of thportraysuite. As of 2021, the original pdoc project is active again. See also *Comparison of documentation generators The following tables compare general and technical information for a number of documentation generators. Please see the individual products' articles for further information. Unless otherwise specified in footnotes, comparisons are based on the s ... References {{Reflist External linksOfficial website [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
NDoc
NDoc is a code documentation generator for the Common Language Infrastructure created by Jason Diamond, Jean-Claude Manoli and Kral Ferch. It is licensed under the GNU General Public License. How it works NDoc uses two sources to generate documentation. The first is an assembly file produced by compiling the source code. The other is a pre-generated XML documentation file, usually produced by parsing the source code for special comments ( C# compilers from .NET Framework and Mono support this using the "/doc" command-line argument). The assembly file is queried using reflection to obtain the list of classes, methods, etc. The XML file is parsed for the documentation text. NDoc uses plug-ins to support several different output formats, including CHM, Microsoft Help Viewer, MSDN-style web pages. Incomplete plug-ins are also included as starting points for developers, like the LaTeX plug-in and Javadoc-style web pages. NDoc comes with a graphical user interface to ease the gen ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
Natural Docs
Natural Docs is a multi-language documentation generator. It is written in C# and available as free software under the terms of the Affero General Public License. It attempts to keep the comments written in source code just as readable as the generated documentation. It is written and maintained by Greg Valure. Background Theoretically, Natural Docs can generate documentation from any language that can support comments, or from plain text files. When executed, it can automatically document functions, variables, classes, and inheritance from ActionScript, C#, and Perl regardless of existing documentation in the source code. In all other languages, these need to be explicitly documented for them to be generated. It can generate documentation in HTML, either with frames or without. Unlike Javadoc, it is not considered an industry standard for documenting in any language, although it can incorporate Javadoc documentation for languages with "full support." It is used by some h ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
EUPL
The European Union Public Licence (EUPL) is a free software licence that was written and approved by the European Commission. The licence is available in 23 official languages of the European Union. All linguistic versions have the same validity. Its latest version, EUPL v1.2, was published in May 2017. Revised documentation for was issued in late2021. . Software, mainly produced by European administrations, has been licensed under the EUPL since the launch of the European Open Source Observatory and Repository (OSOR) in October 2008, now part of Joinup collaborative platform. History EUPL was originally intended to be used for the distribution of software developed in the framework of the IDABC programme, given its generic scope it was also suitable for use by any software developer. Its main goal is its focusing on being consistent with the copyright law in the Member States of the European Union, while retaining compatibility with popular free software licences such as the ... [...More Info...] [...Related Items...] OR: [Wikipedia] [Google] [Baidu] |
