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.

778 questions
248
votes
12 answers

Does Swift have documentation generation support?

Many languages support documentation comments to allow a generator (like javadoc or doxygen) to generate code documentation by parsing that same code. Does Swift have any type documentation comment feature like this?
pconcepcion
  • 5,395
  • 5
  • 32
  • 53
177
votes
3 answers

JSDoc: Return object structure

How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, ...}} description syntax and tried it: /** * Returns a coordinate from a given mouse or touch event * @param …
165
votes
8 answers

How to document a method with parameter(s)?

How to document methods with parameters using Python's documentation strings? EDIT: PEP 257 gives this example: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag…
David Andreoletti
  • 3,552
  • 3
  • 27
  • 47
76
votes
3 answers

How do I create documentation with Pydoc?

I'm trying to create a document out of my module. I used pydoc from the command-line in Windows 7 using Python 3.2.3: python "\pydoc.py" -w myModule This led to my shell being filled with text, one line for each file in my module,…
user1632861
74
votes
3 answers

Objective-C Documentation Generators: HeaderDoc vs. Doxygen vs. AppleDoc

I need to implement a documentation generation solution for my workplace and have narrowed it down to the three mentioned in the title. I have been able to find very little information in the way of formalized comparisons between these solutions,…
KeithComito
  • 1,389
  • 1
  • 13
  • 24
60
votes
3 answers

How can I document data sets with roxygen?

Is it possible to include .R files in the data directory of my package in the roxygen process? I have put several .R files in the data directory. When they are sourced with data(), they read in raw data files and perform some transformations.
Karsten W.
  • 15,931
  • 10
  • 60
  • 93
58
votes
6 answers

Tools and guide for documenting TypeScript code?

Are there any tools for generating documentation for TypeScript source code? Or should I use something generic like NaturalDocs? What would be the recommended style of the block comments / those intended for standalone volume of…
user797257
56
votes
5 answers

How to use Swift documentation comments

I have a few questions about Swift documentation comments: Is there a way to make a Related declarations section like some of the Apple documentation has? For example, when I Option+Click the tablewView(_:heightForRowAtIndexPath:) method, it links…
ad121
  • 1,818
  • 1
  • 16
  • 24
54
votes
8 answers

Generate Protobuf documentation?

Does anyone know of a good tool to generate Google Protobuf documentation using the .proto source files?
54
votes
4 answers

Automatically Generating Documentation for All Python Package Contents

I'm trying to auto-generate basic documentation for my codebase using Sphinx. However, I'm having difficulty instructing Sphinx to recursively scan my files. I have a Python codebase with a folder structure like: └── src └──…
Cerin
  • 50,711
  • 81
  • 269
  • 459
51
votes
5 answers

Documenting C++/CLI library code for use from c# - best tools and practices?

I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way…
Hrvoje Prgeša
  • 2,021
  • 5
  • 21
  • 36
44
votes
3 answers

Has anyone used Sphinx to document a C++ project?

Sphinx is a new documentation tool for Python. It looks very nice. What I'm wondering is: How suitable this is for documenting a C++ project? Are there any tools for converting existing documentation (e.g. doxygen) to Sphinx format? Are there…
Nick
  • 25,635
  • 12
  • 56
  • 71
44
votes
2 answers

How can I list the undocumented modules/classes/constants/methods with yardoc?

I have a small library of code that I am documenting with YARD. When I run the yardoc command, it tells me: Files: 40 Modules: 14 ( 0 undocumented) Classes: 39 ( 0 undocumented) Constants: 21 ( 4…
Jeff Terrell Ph.D.
  • 2,301
  • 25
  • 36
44
votes
2 answers

Is Sphinx already suitable for C++ documentation?

I want to try out documentation generators for a new project in C++. I think my options are either Doxygen or Sphinx. Since I have projects in Python for which I'd like to use Sphinx, I wonder whether Sphinx is the right choice for C++ as well. The…
clstaudt
  • 17,395
  • 34
  • 132
  • 209
43
votes
6 answers

How to get a single PDF document from Doxygen?

When I generate Doxygen documentation in PDF format, I get plenty of different files with a single diagram in each. Is it possible to obtain a single PDF document, organized as a book, roughly as the HTML version? Is it possible to get it…
Pietro
  • 10,628
  • 22
  • 80
  • 165
1
2 3
51 52