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

Documentation Generator for NetLogo model files

I recently stumbled upon the Doxygen Documentation Generator for C++ and especially Qt Code. It generates Documentations in different formats (html, pdf, ...) and includes stuff like Model-Flow-Diagrams. The documentation primitives are used…
nldoc
  • 1,179
  • 5
  • 6
0
votes
3 answers

Unable to Document Header File with Doxygen

I'm attempting to generate documentation for a header file that just contains some constants and I'm not able to generate it. As suggested in the doxygen manual, I've tried adding the @file keyword to a comment block and still no luck. What am I…
Julian B.
  • 3,605
  • 2
  • 29
  • 38
0
votes
3 answers

Rails routes to documentation

I use rails 4 for a restFUL API and would like to use http://apidocjs.com/ as i did with php. I could generate my api documentation in /doc but after I'm wondering what is the best "rails way" to route to this doc. Should I create a controller or…
0
votes
1 answer

JSDoc: Annotating an exported method

If I define an object like this: /** * My Cool Object * @constructor */ function MyCoolObject() { /** * Cool Method, private * @param {!string} parameter */ function localMethod(parameter) { //…
rupps
  • 9,712
  • 4
  • 55
  • 95
0
votes
1 answer

Which document generator is used by peerjs

This question may not be a programming question but it is what every programmer wants, i.e. clear good documentation of it's code, I know there are many document generator tools…
Avinash Agrawal
  • 1,038
  • 1
  • 11
  • 17
0
votes
1 answer

C++ documentation: create map of classes

I've a C++ project structured like this: a main.cpp file in the root folder (where the doxygen_config file is contained) a src folder with all .cpp class files an include folder with all .h class files Even if there's no hierarchy (no heritage and…
user1403546
  • 1,680
  • 4
  • 22
  • 43
0
votes
0 answers

How can I identify comments associated with a Java class/function?

Firstly I'd like to clarify that I'm not looking for suggestions on existing documentation generators. My homework assignment is to build a documentation generator ( like a JavaDoc clone ). Here's what I've done till now : My first observation was…
user2078217
  • 129
  • 2
  • 12
0
votes
1 answer

Does anyone know what, if any, doc generator was used for techbase.kde.org?

I was looking over some of the API reference pages for KDE and was specifically looking into their techcase docs and the more I navigate through the sub-pages of https://techbase.kde.org, the more I really enjoy their readability, lean, clean, etc.…
0
votes
1 answer

How to use docutils to convert .rsts to htmls?

I downloaded a util(cmake,actually) tar,and it's doc was written as .rst files with structure like blow.After googling,I know docutils(a python package) can convert these files to htmls,so installed it ,but I can't find a way to to do it?please tell…
Alex Luya
  • 9,412
  • 15
  • 59
  • 91
0
votes
3 answers

Is there any way to get Visual Studio 2008 to update .net style comments automatically?

I've been writing a lot of VC++ 2008 / CLI software recently and am using the C#/CLI style documentation: /// /// Function the does stuff /// /// Specifies some option /// true if it…
0
votes
1 answer

Convert Joomla website to documentation in PDF, CHM

Currently I have a website made ​​in Joomla that contains documentation about some software (LogicalDOC) in 3 languages. http://help.logicaldoc.com/ I need to convert the various sections in the corresponding PDF manuals. So Installation Guide…
Marcel Piquet
  • 140
  • 1
  • 8
  • 27
0
votes
2 answers

Is there a preferred way to document methods implementing an interface?

I wonder if there's some way of doing this, or even if it should be done? My thoughts soon went to using method attributes as it's a kind of metadata, but I'm unsure if there are any for this purpose. Right now, I'm simply using XML comment
Jonas
  • 1,172
  • 1
  • 16
  • 26
0
votes
1 answer

Document a maven archetype with the project layout and usage

When I generate the site documentation using the site plugin, all I see in the About page is the description of the archetype that I've specified in the element of the archetype's POM. How do I get to see something like the generated…
mystarrocks
  • 4,040
  • 2
  • 36
  • 61
0
votes
1 answer

generating documentation with companion guides using appledocs?

we are working on several internal projects. We would like to keep all documentation in the same place. We are using appledocs for the code documentation. But we need some pages (like apple have their companion guides) that we would like to bundle…
Erik
  • 5,791
  • 5
  • 30
  • 45
0
votes
1 answer

Documenting out-of-line enums with doxygen

When I run doxygen on /// Outer struct struct X { /// Inner enum enum Y : long int { /// value a v = 1, w = 2 ///< value b }; }; I obtain the expected documentation. However, if the enum is out-of-line ///…
Hector
  • 2,464
  • 3
  • 19
  • 34