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 do I pass parameters to Windward DocGen?

I need to pass parameters (variables) in to my document template when running a report. How do I do this? I am using the .NET version of Windward.
David Thielen
  • 28,723
  • 34
  • 119
  • 193
0
votes
1 answer

Rails - Generators Module - How to insert method to application_controller?

I would love to clean this code up: def insert_general_methods inject_into_file "app/controllers/application_controller.rb", after: "protect_from_forgery" do a = "\n\n private\n\n def current_user\n" b = " @current_user ||=…
0
votes
1 answer

How do I generate documentation which displays files inline documentation in 1 column and code in another?

I've seen it before, but I can't remember which project or which documentor they used (if any). I'm pretty sure it was a JS project, probably a Node.JS module. Anyhow, the documentation was listed by file, and each page displayed as 2 columns, one…
Dean Rather
  • 31,756
  • 15
  • 66
  • 72
0
votes
1 answer

YUIdoc doesn't parse my files

im trying to get the hang out of YUIdoc, but i cant get it to work: This is a part of my PHP code: /** * Estimates whether a number is odd or even * *@method odd_or_even *@param num {number} String to fix *@return {Boolean} Returns True on even…
Theadamlt
  • 310
  • 1
  • 5
  • 18
0
votes
1 answer

Source file documentation syntax

I'm looking for resources on various code/API documentation syntaxes, such as Javadocs. Are there any other widely used documentation syntaxes? I'm specifically looking for those used in association with C, C++/Objective C/Cocoa, Shell Scripts (if…
Chris
  • 1,037
  • 15
  • 26
0
votes
1 answer

Java A4 printable document

I currently use an ActiveX control to print out an html document from a popup window without prompting the user. I've never liked this method and have finally got around to reconsidering the problem. I've decided to use a Java applet, and have…
papercup
  • 25
  • 3
0
votes
2 answers

How to document class attributes with NaturalDocs

Via """ Function: myfunc Parameters: a - First parameter b - First parameter """ I can document a function and it gets listed in the class summary. How can I do something similar with attributes? Since I don't declare them in python I…
HWende
  • 1,705
  • 4
  • 18
  • 30
-1
votes
1 answer

How to write docstrings for functions written in functional paradigm using pipetools

I use pipetools to write functions, which is a "functional plumbing library for python". An example function (from their docs): pyfiles_by_length = (pipe | os.listdir | where(X.endswith('.py')) | sort_by(len).descending | (enumerate,…
-1
votes
1 answer

Remove source code from Doxygen but keep method parameter names

In a C++ project, I describe methods and functions in my headers like so: int foo(float, bool, std::string); and in my implementation, name the parameters: int foo(float f, bool b, std::string str) { ... } and if I generate my…
agregate
  • 163
  • 6
-1
votes
1 answer

How to correctly add documentation in my c# code (similar to javadoc)

Is there any native way of documenting my code in C#? Something similar to javadoc in java and different of doxygen or Sandcastle.
danteMesquita
  • 87
  • 1
  • 7
-1
votes
1 answer

Unable to generating client typescript-fetch at https://editor.swagger.io/

Hey guys I am having problems to generate client typescript-fetch from https://editor.swagger.io/ When I try to generate typescript client, nothing happen and it shows this on the console >console output< it doesn't happen when I try to generate…
-1
votes
1 answer

Symfony: Generate documentation from markdown with Table of contents

What are the best practices for generating a documentation (of a tool/service) in Symfony? To be a little more explicit: I want to use Markdown to write a documentation I will probably have more files (about 5-10 files) with different topics,…
codiga
  • 537
  • 5
  • 15
-1
votes
1 answer

What framework has been used to build scikit-learn's website

scikit-learn is a very well organized website and is a neat way to document source code. Are the webpages automatically-generated? Is there a framework which produces these pages? Learning which framework has been used can help me document other…
-1
votes
1 answer

Which documentation system uses this format?

#pragma region INFO /* * @ FUNCTION: GetSubStrBetween * * @ PARAMETER(s): * [1st] std::string &in_Str = This paramter takes in a std::string, which * is the string that contains the unknown sub-string. * * [2nd]…
-1
votes
1 answer

Parsing a php script for documentation purposes

I've not been able to find any inexpensive tools to document all the vars/consts/functs/classes/includes in a PHP script, so I'm writing my own. (I use a lot of open source scripts that need to be modified. Plus, it would be nice to have a directory…
1 2 3
55
56