Ben Laurie wrote:
>
> Damien Miller wrote:
> >
> > On Fri, 13 Aug 1999, Ben Laurie wrote:
> >
> > > > Ben already tried Doxygen some time ago. And there are various
> > > > similar approaches. Seems we've to evaluate most of them before
> > > > we should stick with one. Ben, what were your latest experiences
> > > > at this corner? I ask, because I've to admit that I've still
> > > > not found a tool for any of my projects which makes me really
> > > > happy. But doxygen was certainly still one of the better ones...
> > >
> > > I got no further: I can only take so much negativity before I give up.
> > > I'm still convinced that inline docco is the only kind with any hope,
> > > and doxygen did a reasonably good job. Other suggestions are welcome, of
> > > course, particularly if accompanied by experience.
> >
> > I just had a play with Doxygen - it seems quite nice in that it doesn't
> > get in the way too much and the output it produces is very readable.
> >
> > If I go ahead and start producing patches to add doxygen inline to
> > Openssl header files will they be included?
>
> Actually they should mostly be in the source, surely? I'd be happy to
> have them, but I can't unilaterally make that decision!
>
I've done some stuff in plain text just so people have a clue what some
of the new stuff does and to remind me what some of the stuff does too.
Plain text is not nice but anyone can read it and its a hell of a lot
better than nothing.
As I said before. I don't really care too much what is used as long as
it doesn't get in the way.
As long as you can also document programs and write things like
tutorials or sample code, not necessarily tied to any function then it
is OK with me.
We badly need some documentation, particularly SSL related. The same
questions keep getting asked, like how to setup an SSL connection how to
handle non blocking IO, client verify etc. Quite a bit of "noise" would
be removed if this was documented: even if just a digest of the answers
we've given.
Steve.
--
Dr Stephen N. Henson. http://www.drh-consultancy.demon.co.uk/
Personal Email: [EMAIL PROTECTED]
Senior crypto engineer, Celo Communications: http://www.celocom.com/
Core developer of the OpenSSL project: http://www.openssl.org/
Business Email: [EMAIL PROTECTED] PGP key: via homepage.
______________________________________________________________________
OpenSSL Project http://www.openssl.org
Development Mailing List [EMAIL PROTECTED]
Automated List Manager [EMAIL PROTECTED]
