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.
1
vote
1answer
106 views
How to embed an article in the source code?
Sometimes, I notice typos in articles (blog posts) or books in source code that appears in the body of the article. It may be an indication that the code has been manually copied and pasted (e.g. ...
4
votes
1answer
93 views
Duplicating documentation on interface implementations/overrides good or bad?
So we have an interface like so
/// <summary>
/// Interface for classes capable of creating foos
/// </summary>
public interface ICreatesFoo
{
/// <summary>
/// Creates foos
...
0
votes
1answer
114 views
Functional document from code
I am a Sr java Developer and have recently joined a new team. Here I have been asked to create a functional document looking at the code of a legacy application. This application was written about ...
3
votes
1answer
82 views
Does doxygen support templates for the HTML output?
I've documented my code for doxygen, but I don't want the default HTML it gives. I know I can customize it by providing custom CSS, headers, footers, etc. (like GNOME does), and how I can add common ...
0
votes
0answers
118 views
What is Highcharts using to generate their JavaScript api documentation? [closed]
The Highcharts 3.0 beta was announced today and there's a healthy discussion occurring on Hacker News. In the thread of comments about the release was a comment from Torn about what Highcharts is ...
-3
votes
1answer
80 views
System for checking code comments relevance [closed]
When I write comments for auto generated documentation it can become irrelevant after a few changes of the method. Do we have any system to automatically check, prevent such situation and warn ...
1
vote
0answers
81 views
documentation of typescript code
my question is rather short:
How do I document typescript code properly?
I found out that for projects becoming bigger and bigger, it is important to look at a function and immediately know ...
2
votes
1answer
51 views
Documentation Generation - FiM++
This is a question I originally asked on Stack Overflow, but as a conceptual design question as opposed to a technical issue, I believe it may be more appropriate, or possibly have alternate parallel ...
2
votes
1answer
160 views
Should generated documentation go in version control history?
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 ...
6
votes
2answers
126 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 ...
8
votes
3answers
135 views
How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
1
vote
1answer
132 views
How to document unlimited argument parameters?
In PHP you can have a function take an infinite number of arguments like
/**
* Do abc...
*
* @since 1.0
* @param mixed $arg1 Arg description
* @return string ...
2
votes
2answers
151 views
HTML in docblock comments?
In the PEAR standards there is no reference to HTML, if its allowed or not.
http://pear.php.net/manual/en/standards.sample.php
But I see some people use HTML tags like <kbd> and stuff..
So is ...
5
votes
4answers
397 views
How do you keep track of the meaning of your SQL fields?
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 ...
8
votes
4answers
428 views
Where to put code documentation?
I am currently using two systems to write code documentation (am using C++):
Documentation about methods and class members are added next to the code, using the Doxygen format. On a server Doxygen ...
