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

Issue with image referencing when generating a styleguide using kss-node

I'm using the NodeJS implementation of KSS. I have the following file structure: sass (.scss files) css (compiled .css files) images (images & sprites) styleguide (auto-generated styleguide html) |- public …
Craig Myles
  • 5,206
  • 3
  • 40
  • 37
0
votes
1 answer

.NET XSD Documentation Generator

I'm looking for an XSD Documentation Generator for .NET. Please, provide any references. Note: If it is available with source code that would be much better choice. Thanks.
Ramiz Uddin
  • 4,249
  • 4
  • 40
  • 72
0
votes
1 answer

Generating a nice web documentation from .pdf or .tex

I wrote a documentation for an application in LaTex, and was wondering what the best way to display in a webpage. I can just convert it to HTML, but I'm wondering if there's a better way with all the nice css styling done automatically as in other…
xcorat
  • 1,434
  • 2
  • 17
  • 34
0
votes
1 answer

Is there a plugin for pyramid to display documentation?

Is there a plug-in for pyramid that automatically display a documentation from a pdf file or a tex file? what's the regular way something like the documentation in pyramid is written?
xcorat
  • 1,434
  • 2
  • 17
  • 34
0
votes
1 answer

Include text from one apt to another apt

Imagine I have three apt files: main.apt Info, details, etc.. some text Configuration some text child1.apt Info, details, etc.. some text Configuration [Same text as MAIN.APT configuration] child2.apt Info, details, etc.. …
Zilvinas
  • 11
  • 3
0
votes
1 answer

How to generate documentation from XML documents?

I have been given a set of XML documents from a company that is meant to include the "documentation" of the XML schema. There are no XSDs provided. How can I generate documentation (eg. HTML or CHM) from these XML documents that includes…
CJ7
  • 22,579
  • 65
  • 193
  • 321
0
votes
2 answers

exporting to word file( *.doc ) in php

i have one php page which prints some information. Information is a table with some values dynamicaylly printed in table cells.Now instead of sending this page to browser i want the page to be exported to a word file.How can i do it? In short i have…
user156073
  • 1,933
  • 8
  • 31
  • 37
0
votes
1 answer

Yii Documentation: Generate Html Help Project files

I need to generate MS html help project files (that is html/js/image files plus .hhp, .hhk, and .hhc) from Yii Docs build system but I'm yet to find how to do It. I don't need a compiled CHM, just the project files. I work from Ubuntu Linux Any…
Stefano Mtangoo
  • 6,017
  • 6
  • 47
  • 93
0
votes
1 answer

What documentation to use for VB.NET 4.0

I'm looking for a tool that generates documentation from source tags in VB.NET 4.0 code. Some of the problems I have encountered so far: doxygen does not support VB.NET NDOC and others are deprecated, or do not handle generics, etc. Sandcastle is…
gpinkas
  • 2,291
  • 2
  • 33
  • 49
0
votes
2 answers

How to document a type returned by a function (not constructor), and its methods

I'm using JsDoc3 and the Closure Compiler. I use a JsDoc template which outputs JSON for me to make HTML from it with a custom script. I have a function which returns a custom class (but I don't have, nor need, a constructor), and I want to be able…
0
votes
2 answers

Creating javadoc style documentation without source code

I'm looking into writing documentation about some functions but do not want to write the documentation in the source code. Is there a template I can follow, e.g XML, or something which can generate some sort of Javadoc-ish looking style…
kkudi
  • 1,625
  • 4
  • 25
  • 47
0
votes
1 answer

Excel File Schema

I have an excel file in which I have documented the database dictionary. Each table is documented under following major columns: Name Fields Comments Count I want to generate a visual schema of this documentation - something catchy like expanding…
khan
  • 7,005
  • 15
  • 48
  • 70
0
votes
2 answers

What framework is used to build developer.android.com?

developer.android.com has a nice cool look. Is it based on any known documentation tool, or is it completely custom build by google just for that site? Just a sample of a page with multiple sidebars and table of contents…
0
votes
0 answers

Epydoc with django

I am trying to generate doc thanks to epydoc. I wrote the confdoc.txt My input of modules is from : C:\Documents and Settings\drale\Desktop\new\project. I have a mistake : Could not find a file or object named C:\Documents and…
user1507156
  • 539
  • 1
  • 7
  • 12
0
votes
1 answer

Using Swagger across multiple browsers

Who knows the issue? It seems Swagger cannot support IE. I deployed Swagger example as following in Tomcat. The example works well in Google Chrome & Firefox. https://github.com/wordnik/swagger-core/tree/master/samples/no-server But the example…
Dylan
  • 179
  • 2
  • 12