[Bug 60015] better integration of code and documentation

[Sphere]

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
     
http://bugs.kde.org/show_bug.cgi?id=60015     




------- Additional Comments From sphere1952 at attbi.com  2003-06-18 21:49 -------
Subject: Re:  better integration of code and documentation

Thiago Macieira wrote:

>------- You are receiving this mail because: -------
>You reported the bug, or are watching the reporter.
>     
>http://bugs.kde.org/show_bug.cgi?id=60015     
>
>
>
>
>------- Additional Comments From thiagom at mail.com  2003-06-18 21:25 -------
>You want Doxygen: http://www.doxygen.org 
> 
>Look at KDE's source code and .h files. That's how we generate the 
>documentation. Besides, since KDevelop uses KDE's common admin/ tree, it 
>boils down to: 
>1) adding "include $(topsrcdir)/Doxyfile.am" in your Makefile.ams 
>2) you writing the documentation.
>
>  
>

Besides, you don't get my point.  I don't want documentation on how to 
use the
code.  I want documentation on what's going on in the code.  The only way
that's ever going to happen is if people can add to it while debugging.  
This is
the only time people are thinking about what's really going on, and then 
they'll
document only because they don't want to have to find their way from 
twiddle 1
to twiddle 2 again.