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

How to add tab space infront of mutiple lines of code

I am using eclipse IDE for development I have written some code in if-else block and now I want to tab indent every block, Is there any way or command or key sequence so that I can select the lines of code and simply add tab space in front of every…
DCoder
  • 3,486
  • 7
  • 36
  • 68
0
votes
1 answer

Python and JavaScript/AngularJS documentation on the one server?

The advantages of this approach include: Consistent docstring syntax everywhere Centralsied documentation server; find all your docs in one place Search and jump-to-source from any documented function or class; in either language Are there any…
A T
  • 13,008
  • 21
  • 97
  • 158
0
votes
3 answers

Documentation from XML Doc in VS

Tell me, please, is it possible to generate from standard XML Doc in Visual Studio a proper documentation? With exports from xml into user-friendly look?
Evgeny Gavrin
  • 7,627
  • 1
  • 22
  • 27
0
votes
3 answers

How can I generate document from Android Source zip file?

I downloaded Android's 4.4 source file and I would like to get its API as html? I have ADT bundle and IntellijIdea 13 installed, I tried to import and then generate Doc, but I couldn't,some errors, I searched over internet but I could not find a…
daniel
  • 697
  • 5
  • 15
0
votes
2 answers

Bulk generation of many office documents - which technology is best suitable?

We are going to develop tool which has to initialize large folder structure (for engineering project) with many structured MS Office documents (Word, Excel). So the question is about best suitable MS technology for this task. This task is very…
oxfn
  • 6,590
  • 2
  • 26
  • 34
0
votes
1 answer

Documentation of functions (author, deprecated, etc.)

Most web apps have a special way to describe their functions. Like this: /** * Represents a template function. * * Use Twig_SimpleFunction instead. * * @author Arnaud Le Blanc * @deprecated since 1.12 (to be removed in…
blah
  • 65
  • 7
0
votes
2 answers

Generating JSON from java file

Is there a standard or existing way to generate 'something' from an uncompiled java class based on its contents? So basically something like this: @MakeJsonDocumentation public class ExistingClass{ private name = ""; public…
Timotheus
  • 2,250
  • 5
  • 29
  • 39
0
votes
0 answers

Integrating Search-SphinxsearchBundle into Symfony

I'm using Symfony-standard, I have installed Search-SphinxsearchBundle I was assuming, i would use it's services in controller, to fetch documentation in my app/Resources/docs, where there's index.srt, I need to know how to direct the bundle to…
mukulu
  • 161
  • 1
  • 6
0
votes
1 answer

How to document private (non public interface) by using appleDoc?

recently I have learned how to use the appleDoc to do the documentation for my iphone project. But what I realize is that AppleDoc only scan the head file of each class and based on the special comment format it creates the docSet and html. My…
TypingPanda
  • 1,607
  • 3
  • 19
  • 32
0
votes
2 answers

Need to write a script working under Win32 to put the tags in place for documentation automatically C++/C#

We are managing a C++/C# library and we noticed that many classes and functions were left undocumented. We thought about writing a script which would parse the code to look for undocumented classes and method to produce a list of undocumented…
BlueTrin
  • 9,610
  • 12
  • 49
  • 78
0
votes
1 answer

Online javascript documentator for online scripts

I'd like to use my existing javascript on our production server to create docs when I need them. I comment all my code, I'd prefer to not install anything and use it online. If it splits the comments to the left and puts methods on right that'd be…
Michael J. Calkins
  • 32,082
  • 15
  • 62
  • 91
0
votes
1 answer

Documentation-generator for Ant?

At my company we have a very complex build-system based on Ant. Understanding it took me a long time. I'm currently restructuring it and would also make it easier for new developers to win through it. Is there any (good) documentation-generator that…
Hedge
  • 16,142
  • 42
  • 141
  • 246
0
votes
1 answer

How do I markup a word document with template directives?

I have the unenviable task of writing a template system that sits on top of word 2007/10/13 which allows people to inject simple logic into the document from a back end data store (TBD but this is likely an exported XML document of some form) in the…
pointyhat
  • 167
  • 1
  • 1
  • 10
0
votes
1 answer

Doxygen latex misinterpreting preprocessor definition

Ok let me try this again on SO instead of Tex. So I'm trying to create some PDF's using Doxygen. I've installed MiKTeX on my Windows 7 box and have managed to get all the Styles needed to get Doxygen to generate a PDF. Problem is it never resolves…
Dan
  • 2,625
  • 7
  • 39
  • 52
0
votes
2 answers

How to define the help of the CLI program in the __doc__?

I would like to do something like this : def main(): """ Display Information about a Google Calendar -u --user login Google Login -p --pass password Google Password -d --debug Set DEBUG = True -h --help …
Natim
  • 17,274
  • 23
  • 92
  • 150