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
10
votes
3 answers

Using Cucumber or RSpec+Selenium to create end user documentation?

Has anyone tried creating end user (potentially online, potentially to be printed) help/documentation out of your cucumber scenarios? Or taken screenshots for use in documentation using RSpec and Selenium RC's ability to do so? For Cucumber, I'm…
carols10cents
  • 6,943
  • 7
  • 39
  • 56
10
votes
4 answers

Is there a Javadoc-like plugin for Xcode that automatically generates the doc template?

I'm aware of Doxygen to generate the documentation. What I'm looking for is quick way to insert documentation in Xcode similar to what Eclipse does when editing Java files. Let's say I have an objective-c method with a couple of arguments like…
Mark
  • 343
  • 1
  • 4
  • 13
10
votes
2 answers

How do I indicate collate order in Roxygen2?

Using roxygen2 documentation with devtools document function automatically generates a Collate: field in the package DESCRIPTION, regardless of whether or not it is necessary to load the package library files in a particular order. I'm working on a…
cboettig
  • 12,377
  • 13
  • 70
  • 113
10
votes
2 answers

How to reference to member group in doxygen

I have found how to give a group of class members a name: /**\{ \name Foo */ members /** \}*/ , but how do I reference to Foo from other class members?
user877329
  • 6,717
  • 8
  • 46
  • 88
10
votes
3 answers

_Best Practices for JSDoc'ing Javascript files written in the "revealing module pattern" Style?

Most of my Javascript functions are relatively simple, and called for their sideeffects: I use jQuery to manipulate the DOM or make Ajax-calls. I prefer to write my functions in the "revealing module pattern" style. I just discovered that JSDoc-…
knb
  • 9,138
  • 4
  • 58
  • 85
10
votes
1 answer

How to ignore a class when generating XML documentation for a Visual Studio project?

I have a Visual Studio (C#) project in which the "XML documentation file" property is enabled. It also has "Treat warnings as errors" set to All. There is one particular class which has no XML comments and they will not be added to it. Since XML…
brett rogers
  • 6,501
  • 7
  • 33
  • 43
9
votes
2 answers

Antora top navigation bar customization

My question is quite simple though I cannot find anything that points to it in the documentation. I am generating documentation for a project with the default generator in Antora but I cannot figure out how to customize the top navigation bar, items…
Germán Diago
  • 7,473
  • 1
  • 36
  • 59
9
votes
1 answer

How do you get the XML documentation to show for a referenced C# library?

Suppose you have a C# library with several functions, all documented with the usual /// filled out nicely. Referencing the project will make the function and parameter description appear in the Visual Studio contextual help. But is it…
MPelletier
  • 16,256
  • 15
  • 86
  • 137
9
votes
1 answer

Which documentation generator is used for lodash.com

Any ideas what is the documentation generator used by lodash.com? I have been looking around into their documentation and using google and cannot find anything. I'd like to use a similar documentation style on a small project of mine
Moataz Elmasry
  • 2,509
  • 4
  • 27
  • 37
9
votes
1 answer

How to document an API and still respect HATEOAS?

I'm designing a REST-like API over Http. I need the API Clients (apps, not browsers) to follow the links (HATEOAS), not to build them. Also, I'll still use readable URLs for some reasons that can be disagreed. However, if pretty ways to document url…
Myobis
  • 1,347
  • 16
  • 27
9
votes
4 answers

ASP.Net Web API Help Page Area returning empty output

I have a preexisting MVC app that I added Web API and Web API Self Documentation using Nuget. While the Web API controllers function fine (return valid responses to HTTP requests) the Help controller is not finding any Web API methods to…
Adam Levitt
  • 10,316
  • 26
  • 84
  • 145
9
votes
2 answers

Does Visual Studio have an option to generate html documentation for Javadoc-style comments?

Does Visual Studio have an option to generate html documentation for Javadoc-style comments? If so, what steps are necessary to accomplish this? In BlueJ there is an option to translate Javadoc-style comments into an html file. Like the following…
9
votes
3 answers

Generating Rest API documentation using swagger or any other tool

I am looking for a way to document my Rest APIs. My server is a Tomcat/Spring server and the Rest APIs are implemented using Jenkins. Swagger seems to be a pretty cool solution but i can't figure out how i can use it with my code. I am looking for…
Erik Sapir
  • 23,209
  • 28
  • 81
  • 141
8
votes
1 answer

JSDoc Toolkit - How to specify @param and @property on same line

Is there a way to avoid having to type two seperate lines for @property and @param if, as in the example, on the constructor the parameters and properties are identically named. /** * Class for representing a point in 2D space. * @property…
8
votes
2 answers

What is your preferred document format for documenting databases

I am in the process of writing an application which, among other functionality, generates MediaWiki documentation of an MSSQL database (objects, tables, table data). My question is which document formats you prefer, or are required to produce. I…
devio
  • 36,858
  • 7
  • 80
  • 143