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
7
votes
1 answer

Editing method comment template in Netbeans 6.9.1

When I create a method comment in Netbeans by typing /** + ENTER I get something like this /** * * @param nameOfParam * @return * @throws SQLException */ but in my case I like comments looking like this /** * * @param * nameOfParam -…
derroman
  • 309
  • 2
  • 11
7
votes
3 answers

ngdoc documentation for controller

I am to new to code documentation and trying to document my angular application with grunt-ngdocs. I cloned a working example from: https://github.com/m7r/grunt-ngdocs-example The given example lacks a documented controller so I added my own…
7
votes
1 answer

Doxygen equivalent for Mathematica?

How do you put additional information into a Mathematica package file, like parameter specification doctests/example usage? Up to now, I only found the ::usage string and some information on how to write documentation notebooks. I am looking for…
Karsten W.
  • 17,826
  • 11
  • 69
  • 103
7
votes
0 answers

Page-level docblocks and phpdocumentor templates

I'm having a really hard time to get phpDocumentor 2 working. I have several files in procedural style, that must be documented. The only I found to do that is to use page-level docblocks, but it seems, that they don't work anymore correctly in…
Lorenz Meyer
  • 19,166
  • 22
  • 75
  • 121
7
votes
3 answers

How to use inline comments to document members in .NET?

How can I document a member inline in .Net? Let me explain. Most tools that extract documentation from comments support some kind of inline documentation where you can add a brief after the member declaration. Something like: public static string…
Curro
  • 832
  • 2
  • 10
  • 14
7
votes
4 answers

Replacing python docstrings

I have written a epytext to reST markup converter, and now I want to convert all the docstrings in my entire library from epytext to reST format. Is there a smart way to read the all the docstrings in a module and write back the replacements? ps:…
tomaz
  • 141
  • 2
  • 6
7
votes
1 answer

doxygen+sphinx(breathe) for documentation

I am new to doxygen and sphinx usage. I have a requirement to create documents which is programmed in C language. The idea is to generate xml files from doxygen for each file and then use breathe as a bridge to sphinx for creating html pages. I am…
7
votes
1 answer

Marking "example usage" in code documentation

What is the best practice of placing example usage in code documentation? Is there a standardised way? With an @usage or @notes? Do document generators tend to support this? I know this question should depend on the documentation generator. However,…
Ross
  • 14,266
  • 12
  • 60
  • 91
7
votes
5 answers

Can't install phpDocumentor via Composer

In composer.json I've got { "require": { "phpdocumentor/phpdocumentor": "*" } } It's what is there because I'm trying to install phpDocumentor into an isolated folder with ./composer.phar install command. But what I'm getting…
Desmond Hume
  • 8,037
  • 14
  • 65
  • 112
7
votes
1 answer

Documentation system which is independent of programming language

Is there a documentation system which is simple, will generate some friendly, hyperlinked documentation, for any language through the use of comment indications? Such a system may merely be given regexes or patterns to recognise comments and then…
Christopher Done
  • 5,886
  • 4
  • 35
  • 38
7
votes
2 answers

Pl/SQL Package Inline Documentation

I am attempting to more fully document our database packages as an API. What we would like is something like JavaDocs for PL/SQL. I have seen a couple tools out there (pldoc, plsqldoc) but would like to know from people who use them how they…
Adam Hawkes
  • 7,218
  • 30
  • 57
6
votes
3 answers

Ruby equivalent of Sphinx documentation generator?

Ruby has a few good document generators like Yard, rDoc, even Glyph. The thing is that Sphinx does websites, PDF's, epub, LaTex...etc. It does all these things in restructuredtext. Is there an alternative to this in the Ruby world? Maybe a…
6
votes
4 answers

What do sites like Google Docs and Zoho Writer use to generate MS Office documents

I realise this may just be speculation, but I'd appreciate comments from anyone who has some insight into this. Something like MS Word COM add-in, or an OO bridge, or a custom implementation. The reason I want to know is that I want to provide basic…
menko
  • 340
  • 4
  • 12
6
votes
1 answer

Auto generate REST API docs from Symfony

Is there an easy way to generate docs for REST api direct from a Symfony project?
Andreas Köberle
  • 106,652
  • 57
  • 273
  • 297
6
votes
5 answers

What tools are available to document a legacy database schema (PDF, DOC, HTML, RTF)

I need to document a legacy database schema for a new employee and as there's no design document I'd like to generate one from the existing schema. As the tables are MyISAM the foreign key relationships won't produce a nice graph. I'm interested in…
BenM
  • 4,056
  • 3
  • 24
  • 26