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

Create documentation similar to ebay's api documentation

We are developing a very complex eCommerce portal using asp.net c# and the client asked us to make the documentation very similar (look & feel) with the ebay api documentation. Do you have any idea what kind of tool they are using and if not do you…
morcovar
  • 1
  • 1
-1
votes
1 answer

How to export from Wikimedia to CHM file?

I would like to export some pages in my Wikimedia project to a CHM file. I thought about using a plugin for a browser or something like that, but I haven't found anything. Any suggestion? Thanks a lot.
sipan
  • 1
-1
votes
1 answer

Self-contained documentation for .NET projects - doxygen?

The task We'd like to maintain some developer's documentation for our .NET projects with the following criteria: "Documents", ideally written in Markdown for providing information that's not closely related to a piece of code (like overview,…
Piedone
  • 2,693
  • 2
  • 24
  • 43
-1
votes
2 answers

Create word document from SQL Server Management Studio - 1 row per page (email templates for client to view)

Hey there I have a simple EmailTemplate table with three columns: TemplateName EmailSubject EmailContent I have a client that wants to review all the templates and I'd like to put them into a word document, 1 per page, in the order they are above…
Rob
  • 10,004
  • 5
  • 61
  • 91
-2
votes
1 answer

Is there an easy and convenient way to use SQL Server extended properties for automatic documentation?

To use extended properties for documentation is a striking thought, or to have a easy way to tag your tables, but to set a snippet of documentation you have to execute something like: EXECUTE sp_addextendedproperty @name = N'MS_Description', …
-2
votes
1 answer

How to document source code functions like Unix based man manual?

Like when you document a function in source file it is hard to put all this documentation inside the code files, what i need is to have clean source code file with documentation references in another documentation tool that compiles and presents…
-2
votes
2 answers

Why / is Documentation (Doxygen) removed from msdn?

We are using TFS 2015 on-premise in our sd methodology. Doing this we would like to create our build in TFS, using Visual Studio Build steps. While doing this we would like to insert Documentation (Doxygen) step into the build flow, but every time…
Collapo
  • 3
  • 1
1 2 3
55
56