Questions tagged [documentation-generation]

A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files.

A documentation generator is a programming tool that generates documentation intended for programmers (API documentation) or end users (End-user Guide), or both, from a set of specially commented source code files, and in some cases, binary files.

Document generation can be divided in several type of documents:

  • Batch documents (all automated documents)
  • Interactive documents (documents that can not be produced automatically)
  • Text block correspondence (documents created based on pre-defined text blocks)
  • Forms (forms for websites)

You can place every type of document you come across in one of these categories. A lot of software solutions are offered on the Internet that can automate these processes. In particular, some integrated development environments provide interactive access to documentation, code metadata, etc.

See more information about language support for generation programs at Comparison of documentation generators.

832 questions
24
votes
9 answers

Anything better than PHPDoc out there?

Does anybody use anything else to document their PHP code than PHPDoc? Are there any tools that read the same documentation syntax but give richer output?
Edward Tanguay
  • 189,012
  • 314
  • 712
  • 1,047
23
votes
1 answer

adding useDynLib through Roxygen

I am converting my packages to use roxygen documentation, through the roxygen2 package. Now my package does not load and I think that is is because of the missing useDynLib(mypackage) call missing from the NAMESPACE file. How do I get this…
Andrew Redd
  • 4,632
  • 8
  • 40
  • 64
23
votes
4 answers

Generate Word Documents (in Excel VBA) from a series of Document Templates

Hey all. I'll try to make this brief and simple. :) I have 40 or so boilerplate word documents with a series of fields (Name, address, etc) that need to be filled in. This is historically done manually, but it's repetitive and cumbersome. A…
Alain
  • 26,663
  • 20
  • 114
  • 184
23
votes
5 answers

JSDoc - how to document prototype methods

I've been trying to document the following code using JSDoc: /** * @module person */ /** * A human being. * @class * @param {string} name */ function Person(name){ this.name = name } Person.prototype = new function(){ var…
22
votes
3 answers

Sphinx: List of supported languages for highlighting?

I'm using Sphinx for code documentation and use several languages within the code, I would like to setup highlighting for all of that code. Sphinx briefly mentions a few of the languages it supports (on this page), and then mentions that it uses…
Nic Foster
  • 2,864
  • 1
  • 27
  • 45
21
votes
5 answers

code documentation for python

What is out there on conventions and tools for documenting python source code?
Alex. S.
  • 143,260
  • 19
  • 55
  • 62
21
votes
3 answers

Grails: Alternatives to Grails Doc?

The documentation created by running grails doc is not completely satisfactory in my eyes. For example, actions in controllers appear as properties in the documentation, though I would wish to have an extra section to separate actions from actual…
Erich Kitzmueller
  • 36,381
  • 5
  • 80
  • 102
20
votes
5 answers

Documentation Framework like JavaDoc for Objective C

Does Objective C have a documentation framework similar to JavaDoc where documentation can be generated from the source code?
Casebash
  • 114,675
  • 90
  • 247
  • 350
20
votes
2 answers

How to generate a website from GitHub wiki pages

I've used GitHub pages to generate a beautiful website for my project (this one). Now I want to keep the documentation of my project up to date, and having everything in a single README.md file is probably not scalable to the many features we are…
19
votes
4 answers

VS2010: Autogenerated files and XML documentation

This is really just re-asking this question asked about Visual Studio 2008. Does VS2010 offer any feature to get rid of the CS1591 compiler warning for auto-generated code? CS1591: Missing XML comment for publicly visible type or member To quote the…
19
votes
3 answers

django-rest-swagger nested serializers with readonly fields not rendered properly

I'm building an API with django-rest-framework and I started using django-rest-swagger for documentation. I have a nested serializer with some read_only fields, like this: # this is the nested serializer class Nested(serializers.Serializer): …
19
votes
2 answers

How to use Doxygen plugin in Android Studio?

I need to create a document for my app in Android Studio. I have already created document using Doxygen in eclipse but I don't know how to use Doxygen in Android Studio to generate automatic documentation. I tried searching the web but all I could…
Vicky
  • 921
  • 1
  • 11
  • 33
19
votes
9 answers

Tools to generate a database diagram/ER diagram from existing Oracle database?

Looking for tools (windows platform) to genereate ER diagram (or similar) from an existing Oracle database. Any good tools out there that are free to use or low cost?
18
votes
1 answer

What documentation generator does Google use?

Google has a uniform documentation of all its apis. I wonder what documentation generator does it use and is it available for public use. It has good TOC and other features. Also the code appears neat. Can anyone shed more light on this?
nidheeshdas
  • 1,097
  • 1
  • 11
  • 20
18
votes
5 answers

Autodocumenting Python using Sphinx

This is a generalized version of a previous question regarding Sphinx. Is there a way to recursively autodocument modules or packages which contain classes and functions within them? I think it is silly to add the autofunction or automodule…
Adam Matan
  • 128,757
  • 147
  • 397
  • 562