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
15
votes
1 answer

Postgresql database documentation

I'm looking for a FREE tool which allows to generate documentation for the DB schema, tables, column, keys, indices as a PDF or HTML format like the "Toad Data Modeler" which is a commecial tool. I'm using Postgresql 9.2. Could you suggest me some…
Nko
  • 341
  • 1
  • 7
  • 18
14
votes
3 answers

gRPC documentation generator

Does gRPC support generating documentation for services like Swagger?
Max Ng
  • 449
  • 1
  • 4
  • 10
14
votes
2 answers

Generate Documentation for JSF 2 composite components

I'm looking to generate documentation for a custom JSF 2 composite component library. The composite components are not referenced in any faces-config.xml file, but rather the .xhtml files for the composite components are stored in…
14
votes
2 answers

Is it possible to tell jsdoc to look in a file separate from the source code for documentation of that code?

I would like to keep inline comments as short as possible, since my experience is that comments of more than 3 or 4 lines tend to be glossed over, creating a lot of unnecessary "read the manual lines". I'm required by legacy to adhere to a…
user2999782
  • 153
  • 1
  • 5
14
votes
3 answers

Tastypie documentation generation

I'm trying to use auto-doc tool to generate API doc for Tastypie REST API. I tried Tastytool, but it seems not showing the API's result parameters but the model's columns. Then I tried Sphinx seems more promising since Tastypie supports Sphinx, but…
Jason Xu
  • 2,903
  • 5
  • 31
  • 54
13
votes
1 answer

Scaladoc [use case]

Why do some method descriptions in Scaladoc start with [use case]? Example: scala.collection.immutable.StringOps.++ Is it just a placeholder to be replaced in the future?
Nermin Serifovic
  • 1,327
  • 1
  • 8
  • 18
13
votes
4 answers

How to use phpDoc with overloaded methods?

Let's say I have a PHP class called Color, it's constructor accepts various params. // hex color $myColor = new Color('#FF008C'); // rgb channels $myColor = new Color(253,15,82); // array of rgb channels $myColor = new Color(array(253,15,82)); //…
Tom Pažourek
  • 9,582
  • 8
  • 66
  • 107
13
votes
4 answers

How can I include '<' in Doxygen comments?

Say I'm documenting a member function using DOxygen/Visual studio compatible comments, how can I use the less than '<' symbol without creating a compiler warning but still maintaining readability in the codebase? For example, if I did this: ///…
Jon Cage
  • 36,366
  • 38
  • 137
  • 215
12
votes
2 answers

Is there a way to create a type alias in protobuf (proto2)?

Is it possible to create aliases of protobuf's scalar types? For example, I'd like to use Sequence in lieu of string, even though they would be binary equivalent. My immediate goal is to make documentation (generated with protoc-gen-doc) more…
12
votes
3 answers

Create spec for REST API in Enterprise Architect

My customer wants me to create a specification for a future REST API by using Enterprise Architect (SparxSystems). The deliverable should be well formatted text (can be html, docx or rtf). A class diagram should give a picture of the message…
12
votes
2 answers

How to generate documentation for other projects within solution using DocFx

I am using DocFx to automatically generate documentation in Visual Studio 2015. Per the Getting Started instructions, I added an empty ASP.NET 4 Web Application and used the Nuget Console to install the DocFx build package (e.g. Install-Package…
dalenewman
  • 1,234
  • 14
  • 18
12
votes
2 answers

Ignore some modules in autodoc

I'm trying to use autodoc for selected modules only. I've created a file which includes: .. automodule:: some.specific.module :members: And it gets generated correctly. Unfortunately autodoc keeps trying to parse other files too (and fails…
viraptor
  • 33,322
  • 10
  • 107
  • 191
12
votes
1 answer

Using dub to build documentation

How would I use dub to make DDocs from my source files? There appears to be no default command in dub to do this, and I'd really like to be able to automate this process.
Koz Ross
  • 3,040
  • 2
  • 24
  • 44
12
votes
4 answers

Does Perl have something like Java/PHP Docs?

Does Perl have a Perl Docs generator? Something like Java Docs or PHP Documenter?
Phill Pafford
  • 83,471
  • 91
  • 263
  • 383
12
votes
3 answers

In xml doc, can I insert a reference to a method group? How?

In C#, I can attach documentation for properties, methods, events, and so on, directly in the code using XML Documentation Comments. I know how to insert a reference to a particular method: Is…
Cheeso
  • 189,189
  • 101
  • 473
  • 713