#91 add a note that the lib used to generate Doxygen docs from contracts

[Lorenzo Caminiti]

Add a note in the main docs (just having this in the Release Notes section makes it too hidden).

Wow, I can't believe I still have this code :) but here's an example
of the Doxygen docs generated using the older library rev:
http://contractpp.svn.sourceforge.net/viewvc/contractpp/releases/contractpp_0_2_190/doc/html/str/classstr.html

Generated from this code:
http://contractpp.svn.sourceforge.net/viewvc/contractpp/releases/contractpp_0_2_190/doc/html/Quick_Start.html#A_Complete_Example

I am saying that if you look at the
Precondition/Postcondition/Invariant sections from the Doxygen link
above they merely repeat the assertion code from the contracts you can
read in the code itself. Therefore, this feature wasn't very useful to
begin with then the macros became too complex for the Doxygen pp to
expand them so this feature was removed.

Is this the type of feature you are talking about? If not, could you
provide an example of the code and ideal Doxygen docs generated? (Of
course, you can write everything in just text format but just so I can
see what would ideally be in the code and then in the automatically
generated docs.)

[Lorenzo Caminiti]

• status changed from new to accepted