[Bug 60015] better integration of code and documentation

[Mathieu Chouinard]

[Sphere reply]:
> ------- 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:28
> ------- 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.
>
> Bad answer.
>
> Making the user do things sucks.  Make the code smarter instead.
What you want is called Literate programming ... I invite you to search the 
net for that concept and if you still want that in kdevelop3, you can 
contribute the support.
Mathieu

-- 
You will be given a post of trust and responsibility.