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
0 answers

Compodoc install Error in Angular 4

I try to install compodoc for my Angular 4 Application https://github.com/compodoc/compodoc my node version is : v6.11.1 npm version is v3.10.10 and Os is: Window 6.1.7601 and angular/cli verion is 1.2.6 I got this error while I install Skipping…
ahkeno
  • 113
  • 8
0
votes
0 answers

Using Maven site deploy for http transfer to a Nginx docker container

I have a Maven project that I am generating documentation for and I am using the Maven Site Plugin to do so. I would like to run mvn site:site to generate it and then mvn site:deploy to upload it onto a running Nginx docker container. As Nginx…
0
votes
1 answer

Custom Doxygen permalinks to c++ functions

We use Doxygen for documenting our C++ code and we include the Doxygen results in our Sphinx HTML documentation using the Breathe plugin. We want to jump directly to functions within the HTML documentation using named anchors in a HTML link like…
0
votes
1 answer

Free tool to automaticaly document XSD

When you create XML for some communication or as a configuration file, you will probably want to explain to others how this file works. What tag is used for what. First, you will create XSD, where you will define how to create and use XML. And there…
Srđan Popić
  • 1,191
  • 13
  • 25
0
votes
0 answers

Is there a simpler way of making doxygen skip myclass than with @cond?

I want doxygen to skip one of my C++ classes - and I do not want to tell it to skip the class using files external to the code itself; it has to be inline doxygen markup. I know I can do this with: ///@cond struct Foo { ... } ///@endcond but I…
einpoklum
  • 118,144
  • 57
  • 340
  • 684
0
votes
2 answers

phpDocumentor installation fails in laravel using composer

I am trying to install phpdocumentor using composer by doing composer require phpdocumentor/phpdocumentor in a laravel 5.3 project for generating documentation. I am using a linux machine with ubuntu16.04 and my php version is 7.0. I am getting the…
0
votes
1 answer

Is it possible to generate a TOC tree from my PHP domain?

So I am writing a PHP documentation for my library. I am using the "sphinxcontrib.phpdomain" extension in order to support the PHP domain. Let's say I have defined the following document: .. toctree:: :numbered: :maxdepth: 3 :caption:…
0
votes
1 answer

Cannot run styleguidist along side with laravel development server

I am trying to document my React Components and I am running styleguidist server along side with Laravel development server but the styleguidist server crashes with this error. You have another server running at port 6060 somewhere, shut it down…
0
votes
2 answers

Is it possible to include code examples when using HeaderDoc or Doxygen?

I am writing a Cocoa framework in Objective-C and would like to use a documentation writer to generate the API reference. For .NET, it is easy to include examples using: /// /// /// Console.WriteLine("Hello, World!"); ///…
BWHazel
  • 1,474
  • 2
  • 18
  • 31
0
votes
2 answers

Documentation tool for Ada software

Brief: I'm looking for some kind of tool to produce a software description from the comments in existing software source code. In more detail: I've got existing source code written in Ada. Changes need to be made to this source code and I also need…
Thoran
  • 163
  • 1
  • 9
0
votes
1 answer

How to include documentation for unique match cases in macros?

Is is possible to write documentation for individual match cases of an exported macro. /// This macro does stuff // this works #[macro_export] macro_rules! macro{ /// Today it's time for cats // error: no rules expected the token `[` (cat)…
0
votes
2 answers

Sphinx pdfbuilder format not resolved, probably missing URL

I am trying to generate a pdf using rst2pdf, but keep getting the error "format not resolved, probably missing URL or undefined destination for target". I use sphinx to generate the .rst files and am able to generate the HTML output just fine. To…
0
votes
1 answer

How do you create code references with custom link text in documentation comments?

I am porting an application library from Java to C#. In the Java documentation, there are places that link to a particular code reference using custom text. For example: Suffix --> {@link DataOutput#writeString String} I tried using a similar…
NightOwl888
  • 55,572
  • 24
  • 139
  • 212
0
votes
1 answer

IntelliJ: Cannot Add Custom JavaDoc Tags

What's the problem? And how do I define pre as Precondition in the generated JavaDoc? For example, the supported tag @param is translated into Parameters: ..... in the generated JavaDoc.
NoName
  • 9,824
  • 5
  • 32
  • 52
0
votes
1 answer

How can I exclude a "report.specification" from a Report in Enterprise Architect?

I am attempting to generate a data dictionary for a package, but I cannot figure out how to exclude the report that is my data dictionary. I get this item: in my generated PDF on the last page: I have tried Generate Documentation ➜ Exclude…