Chapter 5. Developer's Guide to Kwave

under construction

Sorry, this chapter is still to be written... At the moment the source code is nearly completely documented with tags suitable with the KDE documentation tools. We currently prefer using doxygen. Maybe some day we will spend some time for writing a tool that converts the doxygen output into something we can include into the docbook source (the source this page has been built of).

If you want to write a plugin, contribute something to this project (or maybe write the converter mentioned above), please feel free to contact one of the authors directly and / or subscribe to the Kwave mailing list. Help is always welcome!

Creating API documentation

If you are interested in the internal of Kwave and you have doxygen installed, then you can type:

% make apidoc

to get a directory apicod/html, with documentation of the source and the internal API in your current build directory.