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
0
votes
2 answers

Wysywig literate programming (or viewing generated documentation on-the-fly)

I use a lot of illustrations, diagrams and equations to document C++ and python codes, and a way to do this is to inline them with doxygen. The problem is that, when coding, they are not directly available in the code (unless I use ascii-art for…
0
votes
1 answer

How to View Documentation on GitHub without Downloading

This is actually a problem I've been having for frequently but I'm finally frustrated enough to look for an answer here. I have been looking into how to use the PyBluez Python package on GitHub. I want to view the documentation so I go to the repo's…
0
votes
1 answer

WebAPI - auto generate documentation with all possible responses

I have read an article http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages and it works fine. But I would prefer to add all possible responses and conditions, when these responses will be sent. Any tool to…
0
votes
1 answer

How does one include non-code embedded (rdoc) rubygem distributable documentation?

I am making a rubygem. RDoc is great for documenting classes methods and fields but I want to have an "overview page" that has a basic architecture synopsis of the module how the classes relate to it etc. It doesn't seem right to have that…
peterk
  • 5,136
  • 6
  • 33
  • 47
0
votes
3 answers

How convert a HTM document to DOC using Java?

I have a HTM document generated in Java and I want to convert to MS Word document. If I try open the HTM document with MS Word, show me a pop-up with an advertisement and I don't want that. I want that the document show it directly. Thanks for your…
Carlos
  • 1
  • 1
0
votes
1 answer

Generating documentation for a Datasnap RESTful API

I've been looking for a way to include an auto-generated documentation endpoint to an existing Delphi Datasnap RESTful API. Can it be done? Are there annotations or external tools I can use? Where would I begin, how would I proceed? If not from…
Wim Ombelets
  • 5,097
  • 3
  • 39
  • 55
0
votes
1 answer

Javadoc Generation Problem in Eclipse

I'm having a problem with the javadoc generation in eclipse. In advance, thanks for taking the time. Here's what happens: I go to Project>Generate Javadoc..., select all of the files in the project, then press finish. Eclipse then goes and seemingly…
exodrifter
  • 658
  • 1
  • 12
  • 23
0
votes
0 answers

jsondoc AnnotationTypeMisMatchException when using @ApiMethod

I'm pretty sure that I'm missing something obvious here, but for some reason I keep getting the 'java.lang.annotation.AnnotationTypeMismatchException' error when I try to run the 'mvn jsondoc:generate -X' command. The full error is shown…
0
votes
0 answers

Doxygen interprets PHP namespace as command in @test command

I think this is an incompatibility between the @test command in Doxygen and php, but I am hoping someone can point me towards a workaround, which my googles skills have been unable to find. The error can be reproduced by documenting the…
Godric Seer
  • 359
  • 4
  • 16
0
votes
1 answer

How to trigger a UNIX command upon build in Flash CS5 (to generate NaturalDocs documentation)?

I'm using NaturalDocs to generate code documentation for a Flash project that we're developing with Flash CS5 on a Mac running 10.6.4. Currently, I have an automator script I can click to trigger the UNIX script and generate the documentation, but…
cc.
  • 3,041
  • 1
  • 21
  • 24
0
votes
1 answer

makefile option to generate latex documentation

I have a project that can be built via makefile, and I would like to add the ability for someone in the base directory to not only be able to build the executable via make, but also to build the documentation pdfs from LaTeX in a separate directory…
Larry Wang
  • 986
  • 6
  • 17
0
votes
1 answer

apidocjs not returning anything in response

I have installed 'apidoc' after installing 'npm' and 'node' for my API documentation by the help of following command: npm install apidoc -g After installing apidoc globally, I simply ran below command on my project directory (assuming apidoc will…
0
votes
0 answers

XML documentation for doc generators bloats files

I'm using Doxygen to generate documentation based on the XML commenting on my source files. The problem I have though is the amount of bloat in the file. There's more comments than there are actual lines of code. using System; using…
Johnathon Sullinger
  • 7,097
  • 5
  • 37
  • 102
0
votes
1 answer

extending jsDoc to handle custom tags

I'm looking to extend jsdoc (particularly with docstrap). I have a nodeJS application and want to split the jsdoc navigation to Controllers, Views ,etc. I've managed up to a certain extent with this by creating my custom tags such as @controller…
user584569
  • 155
  • 12
0
votes
0 answers

How can I convert a bunch of logic and arithmetic to a human readable explanation of specific input variables?

I'm working on a RPG where a character has numerical stats and skill levels and those numbers get used in various ways while performing actions in the game. Are there tools, standards, or processes I can use to take the existing blocks of code,…
Sparr
  • 7,489
  • 31
  • 48