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
8
votes
4 answers

What is the standard way of adding documentation to a JavaScript function?

I'm looking at generating API docs for a JavaScript project. Does JavaScript have anything similar to Python's docstring? function add(a, b) { /** Returns the sum of `a` and `b`. */ return (a - 0) + (b - 0); }
Tim McNamara
  • 18,019
  • 4
  • 52
  • 83
8
votes
1 answer

How can I create a file which documents only "Public" APIs in Doxygen

I have a project which I am working on which is a library. I need to document the internals of the library code for my own purposes, but also need to deliver an API document to my users on how they should use the library. So, in the document I wish…
Brad
  • 11,262
  • 8
  • 55
  • 74
8
votes
1 answer

Is it possible to write Markdown links in a way that satisfies both Github and Doxygen?

My project's current directory structure is /wiki, and there are three Markdown files within the wiki directory. One of them links to the other two, and I have tried two ways of writing the links. First Way [Kernel API & Core…
merlin2011
  • 71,677
  • 44
  • 195
  • 329
8
votes
1 answer

How can I customize Docfx documentation (themes or templates)?

I just started using Docfx and set up some basic conceptual documentation. Now I want to make some adjustments to the theme (company logo, perhaps some font changes, etc.) Minor stuff. The official documentation only gives a high-level description…
enzi
  • 4,057
  • 3
  • 35
  • 53
8
votes
1 answer

How to generate HTML for JSDoc

I'd like to create an auto generating JSDoc documentation file for a framework I'm building but can't seem to find a way to output the documentation. Is it possible to output the doc to JSON or HTML? Or will I have to build my own JSDoc parser with…
Justin Taddei
  • 2,142
  • 1
  • 16
  • 30
8
votes
2 answers

Ruby YARD: documenting abstract methods implementations

I have a typical OO pattern: one base abstract class (that defines abstract methods) and several classes that implement these abstract methods in class-specific way. I'm used to write documentation only once in abstract methods and then it…
GreyCat
  • 16,622
  • 18
  • 74
  • 112
8
votes
9 answers

Are there documented, organized collections of libraries for Common Lisp?

I am a college student at a school that teaches mainly in Java. One of the strong points of Java, which I quite enjoy, is the large collection of libraries. What makes these libraries especially useful is the extensive documentation and organization…
Zoe Gagnon
  • 694
  • 6
  • 9
8
votes
2 answers

Documenting Jersey rest api's

I am looking for a way to generate documentation for my Rest API's that were created using the Jersey framework. Are there any tools to generate such documentation? Also, what are the best practices for documenting Rest API's.
Erik Sapir
  • 23,209
  • 28
  • 81
  • 141
8
votes
2 answers

Sphinx documentation and autodoc-skip-member

I'm building my sphinx doc for a django project the following way: sphinx-apidoc app -o docs/source/app --force Now it includes all of the South migrations which I don't want to have in my documentation. I now tried to exclude them the following…
melbic
  • 11,988
  • 5
  • 33
  • 37
8
votes
3 answers

Using Appledocs to generate documentation

I apologize for the simplicity of my question, but I was trying to generate documentation using Appledocs (https://github.com/tomaz/appledoc#quick-install) I'm not sure how exactly to get it setup. The way I do it is: I clone the github repo and…
8
votes
1 answer

Documentation of classes and modules in YUIDocs

I'm having a bit of trouble writing my documentation for a set of grouped modules. I think it's partly a misconception over what @class, @module and @namespace represent. (Or maybe it's a result of Yahoo trying to shoehorn a 'classical' language…
Andrew
  • 14,204
  • 15
  • 60
  • 104
7
votes
2 answers

Reference a specific class method with @see command using Doxygen

I was not able to reference a specific class method using the doxygen @see command. Suppose I have a class Server with a method start like below @interface Server : NSObject - (void) start:(NSInteger) mask; @end And suppose I have another class…
McLeary
  • 1,231
  • 2
  • 13
  • 21
7
votes
2 answers

How to create documentation for instance variable and methods in Xcode?

I'd like to be able to Alt-Click an instance variable (or a method) as part of the program i created and read what it's purpose is. The fact that Xcode is telling me the class variable is declared at - is nice but not enough. In this case i'd like…
James Raitsev
  • 92,517
  • 154
  • 335
  • 470
7
votes
2 answers

Can XML be documented using Doxygen, Sandcastle, or other documentation generators?

I am currently using Sandcastle, Doxygen, and JavaDoc to generate documentation for code I have written. Is it possible to document XML schemas using these packages? If not, are there any (preferably free!) packages which can do this? I could write…
BWHazel
  • 1,474
  • 2
  • 18
  • 31
7
votes
2 answers

XMLDoc Delphi source code documentation generation

I assume that XML and Delphi Documentation Guidelines are becoming the de-facto standard for source-code documenting comments. That is good. The bad thing is that I cannot find any Delphi documentation generator (free or commercial) that fully…
kludg
  • 27,213
  • 5
  • 67
  • 118