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

Class Documentation Suggestions

We are a Microsoft shop, concentrated on using C#. We have several projects, including websites, Windows services, and class libraries, that incorporate XML comments. I'm looking to generate MSDN-style HTML documentation for each project and deploy…
6
votes
0 answers

Generating API documentation from RESTEasy Annotations

I have a set of Java classes that are annotated with RESTEasy annotations. What I want is to generate JavaDoc like HTML documentation that takes my API interface and shows how to call the API (eg: GET URL) with appropriate inputs and outputs (which…
kierans
  • 2,034
  • 1
  • 16
  • 43
6
votes
1 answer

Sandcastle/SHFB. Add platform icons and version info to help file pages

I am building help file for my library using Sandcastle Help File Builder. The library has three versions (.NET, Silverlight and Windows Phone 7) built from the same code base. I would like to add platform icons next to method names and version…
Bobrovsky
  • 13,789
  • 19
  • 80
  • 130
6
votes
3 answers

Which comments documentation format is better for JavaScript?

Is there are any comments documentation format for JavaScript and processor for this format which generates HTML documentation? Currently I am using VSDoc xml comments for providing IntelliSense help at developing time, but as I know there is no…
6
votes
1 answer

Oracle Documentation Generation Tool

I would like to know if anyone know of a good tool to auto generate documentation of an oracle 9i database schema. I did a reasearch and so far found DBSribe(www.leadum.com) but i'm having problem with it since it giving me an error when doing the…
Sherlack
  • 105
  • 2
  • 8
6
votes
0 answers

How to use Swagger with DTOs shared between a Nest.js API and a SPA?

I have a project with a Nest.js API and an Angular SPA. The DTOs used by the SPA to communicate with the API are in a separate project called Models and I'm using it as a dependency. In that way, I only need to change the DTO in one place, and can…
6
votes
2 answers

How to generate documentation for Asp.Net MVC?

With .net 4.0/Preview kit 2, we can generate help pages for WCF REST. Is there anyway we can do the same for MVC ? www.somewebsite.com/search/help I can create help pages (views) and expose them. I can generate XSD schema and spit out as xml. Any…
Abhilash
  • 121
  • 1
  • 7
6
votes
2 answers

Haddock: Document a declaration with inferred type signature?

Consider the following module {-# LANGUAGE RecordWildCards #-} module Example (foo, fuh, fon, fuzz) where import qualified FirstClassModule (Bar(foo,fuh,fon,fuzz), makeBar) FirstClassModule.Bar {..} = FirstClassModule.makeBar parameter parameter…
Heinrich Apfelmus
  • 11,034
  • 1
  • 39
  • 67
6
votes
1 answer

How to organize multiple outputs inside a single Jekyll project?

I use Jekyll to create documentation for software products. I have 30 + different products that have a common LIQUID template but different content. Every single product documentation has its own table of content. For one project, everything is OK.…
6
votes
2 answers

Documenting Spring @RequestMapping annotations into one location automatically?

Javadoc is great for scanning all of source files and creating HTML pages to view it. I was wondering if there is a similar tool that would go through all of your Spring controllers and collect all of the methods that have been annotated with…
6
votes
2 answers

Using Doc-O-Matic (Express) with Delphi

I am looking for a tool to generate Delphi source code documentation, and I want to give a try to Doc-O-Matic Express (which is free). Are there any guidelines for beginners how to use Doc-O-Matic Express to document Delphi source code (managing…
kludg
  • 27,213
  • 5
  • 67
  • 118
6
votes
5 answers

Documentation and Build system for Mono/C#

I'm starting out on a new project and a team member has decided to use C# as the implementation language. I don't have a lot of experience in C#, but a brief reading shows that it's very capable of being a complete cross-platform vm. Beyond the…
dcolish
  • 22,727
  • 1
  • 24
  • 25
6
votes
2 answers

Extract documentation strings from SQL Scripts

How can I best extract the documentation strings from T/SQL scripts and present them as a user-frienfly API documentation? I know about tools like Doxygen, Javadocs or Sphinx, but none of them seem to know about SQL. For example, I want to be able…
Behrang
  • 46,888
  • 25
  • 118
  • 160
6
votes
4 answers

Documenting Visual Basic 6.0 code

I have just recently been asked to document 10 years worth of VB6 development done by one person. It's been some time since I looked at VB6 code myself, so I'm basically wondering if anyone has any tips for how best to go about it. Is there any…
cc0
  • 1,960
  • 7
  • 40
  • 57
6
votes
1 answer

Is roxygen2 only for documenting R packages or also for R projects?

I have a question about the "roxygen2" package: I have seen a lot of tutorials that make use of it for package documentation (such as the major "object documentation" page by Hadley Wickham) So what if I do have R code that is not a package, say an…
Skybrush
  • 115
  • 1
  • 1
  • 6