Stack Overflow
Stack Overflow

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

Single source documentation tool

What OSS (or free) tools are available for drafting a single source for documentation that can be used to generate manuals? Specifically, in the following formats: HTML website PDF document Embedded (within an application; possibly HTML)1 Text…
Dave Jarvis
  • 30,436
  • 41
  • 178
  • 315
6
votes
4 answers

How to make source code a part of XML documentation and not violate DRY?

I'd like to add parts of the source code to the XML documentation. I could copy & paste source code to some elements, like this: /// /// Says hello world in a very basic way: /// /// System.Console.WriteLine("Hello…
Theo Lenndorff
  • 4,556
  • 3
  • 28
  • 43
5
votes
1 answer

How to generate javadoc using ubuntu + eclipse to my project

My java code has been commented using /** structure for each function. So i want to generate all documentation automatically using: Project > Generate javadoc But by default, on eclipse javadoc is not installed. I have readed many tutorial but…
vgonisanz
  • 11,831
  • 13
  • 78
  • 130
5
votes
2 answers

Autodocumentation type functionality for Fortran?

In the past I've used Doxygen for C and C++, but now I've been thrown on Fortran project and I would like to get a quick all encompassing look at the architecture. In the past I've found reverse engineering tools to be useful where no documentation…
JustADude
  • 2,619
  • 7
  • 31
  • 45
5
votes
2 answers

Showing HTML reports in CruiseControl dashboard

I have been looking into CruiseControl configuration recently (I'm a complete CC noob) and so far I understand that various XML reports generated by your build process (eg mbunit.xml, ncover.xml, fxcop.xml) can be shown in the dashboard by adding a…
James Allen
  • 6,406
  • 8
  • 50
  • 83
5
votes
2 answers

Conditional logic in Markdown or other simple markup language?

Im looking for an implementation of a Markdown-like language that will allow me to embed "conditional logic" within my document. I imagine the document would look something like: This text should be included in all processed versions of the…
rehanift
  • 169
  • 1
  • 1
  • 9
5
votes
2 answers

Can Doxygen process pages other than MainPage.dox

If you put a MainPage.dox file in Doxygen's search path, it will add it to the output in Doxygen/html above the source documentation. But can you have multiple files like MainPage.dox? Or are you limited to one?
Scott C Wilson
  • 19,102
  • 10
  • 61
  • 83
5
votes
1 answer

Documenting PHP classes that use __call()

I was wondering if there is a way to force phpDocumentor to print out the potential methods you could use for getting and setting when you do them dynamically with a __call(). In the case of my simple getter, I would want it to cycle through all…
Toby
  • 8,483
  • 13
  • 45
  • 68
5
votes
1 answer

Doxygen parse javadoc?

I'm curious as to if Doxygen parses Javadoc comments? - that is, does doxygen accept something alike this: /** Greet with a "Hello" message. @param a string containing the name of the person or entity @ret return a string containing "Hello"…
Skeen
  • 4,614
  • 5
  • 41
  • 67
5
votes
0 answers

Angular 2 : Generating Word and pdf from template

I have a Word template with some fields to fill and I would like to use this template in my Angular 2 application to generate the same Word document with fields filled (with an object). As I take the data from a database, I need absolutely to use an…
Nicolas S.
  • 173
  • 2
  • 12
5
votes
1 answer

JSDoc: Why aren't my nested objects links (why aren't they click-able)?

I would think that all members / objects / etc. documented by JSDoc should be their own click-able links; e.g., if I have levelOne --> levelTwo --> levelThree --> levelFour, then I should see levelOne on the first page and be able to click my way…
Ross Brasseaux
  • 3,879
  • 1
  • 28
  • 48
5
votes
1 answer

Doxygen javadoc-style tag description spanning multiple lines

In a C++ project I'm using doxygen and the javadoc style for documentation. I'm fairly new to javadoc and am not sure whether this type of thing is valid. /** * ...stuff... * @return foo foo foo foo foo. Foo foo * foo foo foo foo foo. */ i.e.…
lotad
  • 139
  • 2
  • 6
5
votes
2 answers

Using WCF in .NET how can I make it auto generate SOAP docs like ASMX did?

I'm currently writing a web service using WCF in VB.NET. Previous web services I wrote used ASMX but I wanted to learn WCF and so far it's going well. I actually prefer the way WCF does things. One thing I miss however is the way that ASMX used to…
Hades
  • 1,975
  • 1
  • 23
  • 39
5
votes
2 answers

JSDoc: How to avoid duplicate documentation for properties/getters?

I am currently documenting one of my APIs using JSDoc. Although this works well, one thing that really annoys me is the occurence of duplicate documentation. One common example of this is the documentation of a property and its getter: function…
BlackWolf
  • 5,239
  • 5
  • 33
  • 60
5
votes
1 answer

How to document an array with subarrays (mixed type)?

To document a variable that can take an array that receives a vector whose values ​​are strings: /* * @var string[] An array of string objects. */ $foo = array('A', 'B', 'C'); To document a variable that can take an array that receives a vector…
Protomen
  • 9,471
  • 9
  • 57
  • 124
1 2 3
…
55 56