EDoC++ : History

Motivation

EDoC++ was started in early 2005 due to a need to have accurate documentation for C++ exception propogation. I wanted to use exceptions for my error handling code as it produces clean easy to maintain code. However the use of exceptions in C++ is more dangerous than in many other languages. In Java for example the function to be called documents all the exceptions it may throw, and this is made compulsory by the compiler. This way you know exactly what exceptions may occur when you are using a particular function. To use a similar functionality in C++ (The function throw specifier) is dangerous as if an exception does occur that does not match the specs, then it causes the program to abort. In addition to this the compiler provides no mechanism to enforce this specification at compile time anyway. The combination of these two along with the normal problems of resource leaks in a non-garbage collected language make it quite difficult to use exceptions in C++ and produce reliable safe code. By creating this tool I have managed to alleviate some of the dangers of using exceptions in C++ code that other languages have addressed suficiently as part of the core language.

Origins

I initially started writing code in early 2005. The project did not get far and it was abandoned. A couple of months later I decided to start again from scratch. The project has slowly been improving since then. EDoC++ has improved in usability and speed thanks to help from people on the GCC mailing list.

If you find EDoC++ useful then please consider mentioning it to others, writing reviews on blogs or your own website, and where possible link to the EDoC++ home-page: http://edoc.sourceforge.net/

© 2004 Brendon Costa. E-mail: brendon.j.costa@gmail.com