![doxygen tutorial doxygen tutorial](https://i0.wp.com/www.woolseyworkshop.com/wp-content/uploads/Doxygen_PythonTempSensorClass.png)
![doxygen tutorial doxygen tutorial](https://i.ytimg.com/vi/Rl50qI6e7HU/maxresdefault.jpg)
This is where using doxygen pays off by giving a short comment in the header file a reference manual is automatically generated. While comments in the source file help a lot to gain this knowledge in can get quite tedious go through every file looking for the right tool. Very often it does not in fact matter whether the code itself is understandable, as long as it one can get the information what a function is supposed to do. To facilitate this sharing and reusing of ressources one first and foremost has to know what kind of ressources are already available.įew people write code in the intention for it to be difficult to be used by others, but unfortunately what might seem a very efficient and easily understandable piece of code to the author might be nigh unreadable for someone else. Many of them have written excellent code which can do a lot of things and is very helpful to people who might apply it in wholly unlooked for ways to completely different problems. MITK is a substantial project and encompasses many different source files by many different developers over quite a considerable timeframe. Therefore this document is not primarily intended as a guide to using doxygen, the doxygen manual does a much better job of that, but as a guide to use doxygen in MITK and a collection of helpful hints and advise about pittfalls.Īlso, of course you need to have doxygen installed to generate documentation. So on the technical side many questions can be answered by the doxygen documentation, such as the list of commands or a few basic doxygen tutorials. MITK uses Doxygen for the generation of our user manual pages as well as for the generation of the on- and offline reference manuals.