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

CXF REST APIs Documentation using Swagger

According to Swagger's tutorial, seems swagger only support Jersey framework (See https://github.com/wordnik/swagger-core/wiki/java-jax-rs) Does anybody have experience on making swagger work with CXF JAX-RS implementation? Could you share your…
Dylan
  • 179
  • 2
  • 12
11
votes
6 answers

Help generation tool with MS Word and C# xmldoc support

I'm looking for a help/documentation generation tool which would satisfy such requirements: it should support xmldoc comment produced by c# compiler or (even better) directly support sandcastle it should support importing of MS Word documents. it…
Shrike
  • 9,218
  • 7
  • 68
  • 105
11
votes
2 answers

Using Sphinx docs how can I specify png image formats for HTML builds and pdf image formats for Latex/PDF builds?

Using sphinx doc generator, I am trying to use .png images for the HTML builds of the documentation, and then I want to have the .svg images used for the PDF/LATEx builds. Anyone know how to "tag" sections as "HTML build"-only and "Latex…
11
votes
4 answers

What is the best tool for documenting/generate reference for a RESTful/HTTP RPC API?

Many questions have been posted and answered about REST / HTTP based APIs, etc, but none seem to have much information on the following question: What tools are available/used to document a HTTP-RPC API? Which tools are the best? A Similar question…
Colin
  • 2,001
  • 13
  • 28
11
votes
3 answers

VS2010: Autogenerated XML documentation file does not update

I have a C# project in vs2010 that generates a XML documentation file, where I have set the output path of the generated file to the project output path. My problem is that the file does not update when the path to the document file is the same as…
11
votes
1 answer

How can I get my .NET XML Documentation Comments into Conflunce

I'd like to import my .Net XML Documentation Comments (the documentation based on the code tags, automatically generated by the compiler with the /doc switch) into Atlassian Confluence. I've used Doxygen to generate some HTML which looks great, but…
Ev.
  • 7,109
  • 14
  • 53
  • 87
11
votes
1 answer

Can Doxygen output members purely in order of declaration?

Which Doxygen option can completely disable sorting members by type (Private / Public / Method / Variable), and output members purely based on the order in which they were declared?
Robin Rodricks
  • 110,798
  • 141
  • 398
  • 607
11
votes
3 answers

How should I document a Lua API/object model written in C++ code?

I am working on documenting a new and expanded Lua API for the game Bitfighter (http://bitfighter.org). Our Lua object model is a subset of the C++ object model, and the methods exposed to Lua that I need to document are a subset of the methods…
Watusimoto
  • 1,773
  • 1
  • 23
  • 38
10
votes
2 answers

Documenting a javascript class with prototypes in a namespace using jsdoc-toolkit

I'm trying very hard to document code in the format below using jsdoc-toolkit. It looks to me like the tags I've used should produce the desired result but it doesn't. Instead it warns that Class is undocumented (because it is only defined inside…
dave
  • 2,191
  • 4
  • 21
  • 25
10
votes
1 answer

How to get Microsoft HTML Help 2 Compiler?

Where can I download the Microsoft HTML Help 2 compiler (or bounding SDK)? I want to generate HTML 2 documentation from my programming projects using Sandcastle Help File Builder and the Sandcastle Guided Installation wizard is instructing me to…
John K
  • 28,441
  • 31
  • 139
  • 229
10
votes
3 answers

How to generate reST/sphinx source from python?

I'd like to generate documentation via reST, but don't want to write the reST source manually, but let a python script do that and then produce other formats (HTML, PDF) with sphinx. Imagine I have a telephone book in binary format. Now I use a…
dantje
  • 1,739
  • 1
  • 13
  • 25
10
votes
1 answer

DocFX: Generate API documentation for multiple projects

I'm working on a project that has multiple projects in a solution. I would like to be able to generate the documentation from an outside directory to keep the application code folders clean. When I try to set the src directory in my docfx.json, it…
10
votes
1 answer

How to automatically generate Python API documentation in PyCharm

I have a Python project in PyCharm and I'd like to automatically generate API documentation (in the form of HTML) from my Python code and docstrings. According to this page, there are a number of tools that generate Python API…
dln385
  • 11,630
  • 12
  • 48
  • 58
10
votes
2 answers

Angular2 Documentation Generator

Is there a documentation generator (may be a node package) like in other programming languages (jsdoc / phpdoc / javadoc / ..) for typescript-based Angular2-Projects?
user2227400
10
votes
1 answer

Why is Doxygen so unfriendly to mobiles?

Doxygen seems to be the number one choice for code documentation in C++ (and many other languages) but every time I browse Doxygen generated doc from my phone, the site literally does not scroll, text is horribly small ... How come ? I come from…
Jiby
  • 1,865
  • 1
  • 13
  • 22