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

Is there a website where I can view XML documentation for NuGet packages?

I have published a couple of NuGet packages (.NET class libraries). The packages include XML documentation file for each DLL. All packages are published on www.nuget.org and www.symbolsource.org. Now, is there a website/service which will…
niaher
  • 9,460
  • 7
  • 67
  • 86
0
votes
1 answer

SAP - Understanding HR module structure

We are in the middle of a huge SAP installation. Everything works fine but I'm dissatisfied with the documentation methodology and style of the consultants/developers. The documentation is too fine-grained, developers often are lost in details and a…
boj
  • 10,935
  • 5
  • 38
  • 57
0
votes
1 answer

Haxe documentation XML: how to exclude standard library?

I want to make a small tool in Haxe, that inspects the haxedoc comments. I figured the best way to get these comments is to use the "haxe -xml" option, and load in the resulting XML file. However, when I generate the XML, it seems to include the…
0
votes
2 answers

How do I automatically generate documentation/comments in Monodevelop?

Monodevelop automatically generates verbose documentation for functions and classes if "///" is typed in the appropriate place, upon typing the third '/'. I want it to go over all of my code, though - I thought there was some button somewhere, and I…
0
votes
2 answers

Tools and ways to generate HTML help for built-in help system (QtHelp)?

I'm in the progress of implementing a built-in help system based on QtHelp into my application. Since QtHelp is based on Qt's help collection files, I need to produce a set of HTML pages. Since I won't be writing the documentation alone (a few of my…
BastiBen
  • 19,679
  • 11
  • 56
  • 86
0
votes
1 answer

Equivalent for Dancer of Mojolicious Mojolicious::Plugin::PODRenderer?

I would like to generate documentation in a Dancer application in the same way that Mojolicious does with Mojolicious::Plugin::PODRenderer, I mean in the browser, under the /perldoc path. Does somebody knows a module that can help? I found no…
smonff
  • 3,399
  • 3
  • 36
  • 46
0
votes
1 answer

Add text formatting tags to xml doc

I was wondering if it would be possible to add text formatting (layout) tags to a xml doc. For example: ... /// /// This method is important and it does: <%Go to a new line%> /// - take an input <%Go to a new line%> /// -…
NoIdeaHowToFixThis
  • 4,484
  • 2
  • 34
  • 69
0
votes
1 answer

convert code+comment in source control into a readable documentation

We are using mercurial-hg and git, and are wondering if there is a way to create documentations from the existing code and newly check-ed in code. Is there any plugin that we can hook into mercurial-hg/git that generates documentations? Thanks
Lydon Ch
  • 8,637
  • 20
  • 79
  • 132
0
votes
1 answer

PHP: documentation / hinting via @var with multiple classes/interfaces

I am making usage of /* @var $var Type */ really often for NetBeans can then autocomplete methods and stuff in code. Still I think its a very useful feature but sometimes I got objects of classes extending one more class and implementing…
serjoscha
  • 510
  • 4
  • 10
0
votes
1 answer

How can I read an HTML file a Paragraph at a time?

I reckon it would be something like (pseudocode): var pars = new List(); string par; while (not eof("Platypus.html")) { par = getNextParagraph(); pars.Add(par); } ...where getNextParagraph() looks for the next "

" and continues…

B. Clay Shannon-B. Crow Raven
  • 8,547
  • 144
  • 472
  • 862
0
votes
1 answer

Visual Studio 2012 XML Comments not being built

I've been working on a C# project using Visual Studio 2012 and have been looking into generating documentation. All is going well for the most part, but for some reason, some of the files in the project are not being included in the resulting .xml…
0
votes
1 answer

Can I include an other document/fragment in my xdocreport template?

I'm using XDocReport to create reports using a template like this: «#foreach($developer in $developers)»«$developer.Name» «#end» My question is whether I can include an other document file in my template or not? Example: «#foreach($developer in…
Adam Arold
  • 29,285
  • 22
  • 112
  • 207
0
votes
1 answer

Information architecture for document repositories

I've been tasked with re-designing the architecture of my division's document repositories. We currently have hundreds of documents across multiple SharePoint servers and would like to consolidate them under one repository that will allow users to…
0
votes
1 answer

Don't include the brief description in the detailed description when using Doxygen

I am using Doxygen with C++ and with JAVADOC_AUTOBRIEF set to YES. Is it possible to not include the brief description in the detailed description? Is there a way to configure this in the Doxyfile maybe?
Jaime Ivan Cervantes
  • 3,579
  • 1
  • 40
  • 38
0
votes
3 answers

Create documents without dependency on Office programs?

Is there any way for my app to create a document that will need saved and printed without utilizing some external software? Currently I have a spreadsheet that does a bunch of calculations then a button that runs some VBA to export 2 sheets to a…
TypeM1smatch
  • 225
  • 3
  • 7
  • 15