Re: [Audacity-devel] doxygen
A free multi-track audio editor and recorder
Brought to you by:
aosiniao
From: Joshua H. <jo...@ha...> - 2002-07-01 15:38:30
|
* Shane Mueller (smu...@um...) wrote: > I've tested out doxygen and have had it working in my own source tree > for a few months now. I find it pretty useful, even without the in-line > documentation below. It would be nice to have a version available > on-line as well. I was hesitant about checking it in because aside from > the coding style issues, there are a few other meta-level issues that I > think need to be dealt with for doxygen to be useful. such as.... > > * I've noticed that it can get rather large, and it probably changes a > lot. Should the generated files go in cvs? I'd say definitely not. > * Also, how will it be integrated into the build system? I think "make doc" or "make dox" makes the most sense. > * And will it be a unix-only thing or will pc developers be able to > generate the docs as well? Doxygen itself is cross-platform; all developers on other platforms need to do is invoke it. I'd be surprised if VC++ didn't have a way to do this automatically, but even if it didn't you'd only have to run one or two commands to get it to work. > * If we put it on the web page, what type of policy will we have for > keeping that updated? Hmm, I don't really have an opinion on this. > * Should this be used just be for the development branch? Are you referring to the 1.1 vs 1.0 branch? I think there's zero point in going back and documenting the 1.0 branch now. > Anyway, I don't remember the doxygen file being difficult to set up, but > if you want I can check mine in to CVS or email it to you if you want a > template to start with. Anyway, I think it is a great idea. Sure, email it to me and I'll take a look. One thing I forgot to mention is that I think we should split the documentation into 2 parts: one is the publically accessible interface for libaudacity, and it can act as a reference for using libaudacity. The other would cover everything: the backend of libaudacity, libaudacity's interface, and the GUI code, and it could act as a useful reference for us and also a HACKING file to help aquaint people with the code if they're interested. Josh |