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

Automatic @since javadoc tag for releases

Is there a tool to automatically add the @since tag to all elements when I want to have a release version? So let's say I have a bunch of methods and my base system is working now, so I decide to release it as version 0.1.0 What I want now is a tool…
Mene
  • 3,739
  • 21
  • 40
6
votes
1 answer

Automagically adding yard doc skeletons to existing Rails legacy code

I would like be able to insert templated YARD doc style comments into my existing Rails legacy application. At present it has few comments. I would like class headers and method headers that have the params specified (by extraction from the method…
6
votes
1 answer

Naming a doxygen @ref

How would I go about naming a Doxygen @ref tag? I have tried the following: See @ref hello_world hello for more information Which outputs this: See hello_world hello for more information Where hello_world is linked to hello_world. I am looking for…
Jack Wilsdon
  • 6,706
  • 11
  • 44
  • 87
6
votes
2 answers

How do I omit the values of variables on Sphinx?

I have some module-level variables that have long and uninteresting values which I would like to exclude from auto-generated documentation. Is there a way to do this? For example, in my Python source I have something like #:This is a variable with a…
orome
  • 45,163
  • 57
  • 202
  • 418
6
votes
2 answers

How to create api documents with grunt-ngdocs

I'm trying to create API documents through grunt-ngdocs. The partials are created but the index.html doesn't have the correct links to it. I have in my gruntfile.js: module.exports = function (grunt) { grunt.initConfig({ pkg:…
Lino
  • 295
  • 1
  • 5
  • 19
6
votes
1 answer

How to add add external links in yuidoc (grunt-contrib-yuidoc)

I imagine I'm missing something in yuidoc documentation or misunderstanding usage. I cannot seem to find a way to include a link to an external site/page in my documentation. In a comment block, I'd like to have something like this: /** * Creates…
user56512
6
votes
0 answers

PHP 5.3 Documentor?

Possible Duplicate: Anything better than PHPDoc out there? I was wondering if there is a documentation solution available that supports PHP 5.3. We are having two problems with phpDocumentor. First, it lacks 5.3 support. Second, it requires too…
user256162
  • 61
  • 3
6
votes
1 answer

Doxygen does not generate function documentation

I'm trying to use doxygen for the first time. I'm using it in order document some C library, and structures. I think to use the correct tags, but the documentation is good only as far the define macros are concerned, but the function tags (\fn) are…
Daniel
  • 141
  • 3
  • 14
6
votes
4 answers

wiki/docbook/latex documentation template system

I'm searching for a documentation template system or rather will be creating one. It should support the following features: Create output in PDF and HTML Support for large & complicated (LaTeX) formulas References between…
Wolfgang Ulmer
  • 3,450
  • 2
  • 21
  • 13
6
votes
4 answers

How can I convert an RTF file to a pdf file?

How can I convert an RTF file to a PDF one? I have the adobe PDF printer, should I use it? If so, how can I programmatically access it?
Malfist
  • 31,179
  • 61
  • 182
  • 269
6
votes
1 answer

maven site plugin not deploying subprojects in a multimodule project or generating index.html

I have a multimodule project that I want to deploy a site for, but it seems like my site deployment configuration is not being inherited by subproject child modules. parent moduleA moduleB On the filesystem they are located relative to each…
6
votes
4 answers

Tool to generate documentation from JSDoc on TypeScript interfaces

I have a .d.ts file with the interfaces describing my library. It has JSDoc comments, which will be shown via intellisense in Visual Studio when people refer to the .d.ts in their code: /** Description of JSNLogAppender */ interface JSNLogAppender…
user1147862
  • 4,096
  • 8
  • 36
  • 53
6
votes
2 answers

Program which can produce class diagrams directly from code

I have a somewhat large C# project which I am starting to lose overview of. I was wondering if there was some software out there which could graphically represent my classes, which calls what, and so forth. I have tried googling around a little, but…
John Magistr
  • 872
  • 3
  • 9
  • 22
6
votes
2 answers

Preserving proto comments when generating C# with protobuf-net

We are using protobuf-net to handle our Protocol Buffer needs in a C# application. Since we share our .proto files with other, non-managed applications, we are generating our code from the .proto files (not using the code-first protobuf-net…
6
votes
2 answers

dojo js library + jsdoc -> how to document the code?

I'd love to ask you how do the guys developing dojo create the documentation? From nightly builds you can get the uncompressed js files with all the comments, and I'm sure there is some kind documenting script that will generate some html or xml…
belzebu
  • 810
  • 7
  • 25