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.
8
questions
8
votes
5
answers
2k
views
Where should a programmer explain the extended logic behind the code?
I have developed a few quantitative libraries in C# where it is important to understand not only the classic information that goes with the XMLDoc comments (which contains basic information with the ...
- 1,939
6
votes
5
answers
1k
views
How do you keep track of the meaning of your SQL fields? [closed]
The more SQL fields I add to my tables and the more primary/foreign keys I add the more I lose the overview for specific fields for certain scenarios like Get/Add/Delete/Update data.
I use SQL ...
- 267
4
votes
3
answers
346
views
What could be some pitfalls in introducing a style guide and documentation generating software in a development team?
I'm considering using appledoc, a flavor of Doxygen for use in generating Objective-C code documentation, in order to create documentation for my company's iOS apps. The idea is that a server will ...
- 143
22
votes
5
answers
2k
views
How-to convince company to start documenting for legacy software [duplicate]
It has been less than a year since I joined my current company. Their majority of sales have come from a single product that has been alive since the last 10 years. However, there is minimal (if at ...
- 430
7
votes
1
answer
2k
views
Standardized code documentation format, where is it? [closed]
I'm currently looking into API documentation generation tools and I noticed that apparently there are no efforts going on in standardization.
Javadoc style is kind of an ubiquitous convention... it ...
- 14k
5
votes
2
answers
243
views
Seeking advice on system documentation
I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document ...
- 61
5
votes
1
answer
779
views
Should generated documentation go in version control history? [duplicate]
I'm against compiled stuff going into version control, specially when it comes to compiled binaries, however, my principles are now in question after adding doxygen support for a project.
Should the ...
- 14k
1
vote
1
answer
162
views
Software component type classification [closed]
I'm writing a framework that automatically documents applications dependencies in a distributed system, the idea is to produce something close to an UML component diagram of the whole system at ...
- 127