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

how to make documentation with phpdoc

I had run the this command in my code folder . $ phpdoc -o HTML:frames:earthli -f user.php -t docs It created the folder docs and with html documetation of user. Now if i want to add more file to this package , how should i add to it . I tried $…
XMen
  • 29,384
  • 41
  • 99
  • 151
0
votes
1 answer

Create links between ESDoc functions/classes and manual pages and vica-versa

I'm new to ESDoc but have many years JSDoc experience. The nearest equivalent to JSDoc's Tutorials features is ESDoc's Manual feature. It lets you write stand-alone markdown documentation that gets incorporated into the final built documentation. I…
Bart B
  • 661
  • 8
  • 18
0
votes
1 answer

Is it possible to reuse docs generated by Doxygen and merge with new documentation?

Since the codebase is quite large, Doxygen takes a really long time to run. If I could obtain the modified files from some version control system and run Doxygen on them, is it possible to merge the existing documentation with the new pages…
Ramya Raj
  • 109
  • 1
  • 10
0
votes
3 answers

Creating a "Table of Contents" type Database

OK lets start at the beginning, we are at a stage that we need to create documentation for our product. And as our product is web-based, I intend to create an on-line documentation + add a copy of this on each product. The documentation I have…
0
votes
1 answer

Can I reuse content (single source) in markdown?

Disclaimer: I am a tech writer (not developer, so KIS and be kind please). I write in Markdown. Each MD file is paired with an RST file that serves as either an index to the section (listing multiple files) or, for a topic, just provides a path to…
0
votes
1 answer

Using asciidoc, is it possible to tag a single word as source code instead of an entire line?

I am currently writing a document describing the project I am working on, using asciidoc plugin for Intellij. Basically, I know that this works : [source, java] int i = 0; Output will be : int i = 0; with the grey rectangle, as expected, to…
souki
  • 1,305
  • 4
  • 23
  • 39
0
votes
0 answers

Sphinx build failing on ReadTheDocs

I'm trying to build the documentation for a project using ReadTheDocs. The Sphinx build script is failing with: error: option -T not recognized. I double checked the Sphinx documentation, and the -T option has been available since version 1.2.…
0
votes
1 answer

Adding natural docs style remarks generation to the intellij idea

I'm looking for a way to add natural-docs style remark generation to the intellij IDEA. In a way similar to how javadoc remarks are being generated. I tried the "Settings" -> "Code Style" menu but couldn't figure out how to do it. Natural Docs…
Leeron
  • 147
  • 1
  • 2
  • 11
0
votes
0 answers

Problems with Doxygen and doxypi documenting Python code

I'm using Doxygen 1.8.11 to document a large base of Python code. I'm using it because I wanted the LaTeX documentation support (in addition to .html). Originally, I documented my code following the Doxygen recommendations, meaning without…
0
votes
1 answer

How to install multiple, doxygen-generated documentation conditionally with CMake?

I am having a CMakeLists.txt that conditionally generates various formats of documentation based on the user configuration in the command line. set(DOXYGEN_INPUT ${PROJECT_SOURCE_DIR}/docs/doxygen/Doxyfile.in) set(DOXY_OUT…
Petross404
  • 177
  • 1
  • 12
0
votes
1 answer

Maven to generate an image from an xm

Does anyone know a solution that generates an image (png or something else) from a text file (more precisely an XML) using Maven? I frequently change some XML and would like to include it into the automatically generated documentation of a project.
Walter Kuhn
  • 479
  • 1
  • 6
  • 19
0
votes
1 answer

XML documentation: using "cref" in , is this acceptable or not necessary?

I am using GhostDoc to document my methods etc... and its working well but it doesn't fill the ... Can anyone tell me what i should be doing i.e If it returns an object called "Roles" then A role object see
Martin
  • 23,844
  • 55
  • 201
  • 327
0
votes
1 answer

Generating XML Documentation for single VB Class in WebSite Project

I have Single VB Class inside website project and I need to generate XML Documentation for this class. is there any tool that can generate this documentation? Thanks,
Amr Elnashar
  • 1,739
  • 12
  • 33
  • 53
0
votes
1 answer

how to generate documentation on parse server application

I was wondering if we can generate documentation based on our schema/classes in our parse server powered express application. Also I have around 15 cloud functions which need to have specific post body. It'd be great to have documentation generator
0
votes
1 answer

Docfx not build and output other path

There are two responsibilities; before the first problem my project hierarchy this and I want for each project code to documentation for this i use docfx. first problem; I don't want the building code to be rebuilt. ex. docfx ./docs/docfx.json…
errorau
  • 2,121
  • 1
  • 14
  • 38