[zeromq-dev] Documentation Proposal

Peter Alexander vel.accel at gmail.com
Fri Jul 9 23:08:58 CEST 2010

On Fri, Jul 9, 2010 at 4:33 PM, Pieter Hintjens <ph at imatix.com> wrote:
> On Fri, Jul 9, 2010 at 10:24 PM, Martin Sustrik <sustrik at 250bpm.com> wrote:
>> What about the generated documentation though?
> Like I said, generated documentation can go to any suitable medium.
>> What Peter have done is generated documentation for 0MQ codebase (as
>> opposed to API) which falls into the same category.
> Indeed.  Sorry, I meant "codebase" when I wrote "API"... I assume the
> generated documentation is for methods and classes, which means 'api'
> to my mind.
> Generating documentation is an experiment which may or may not
> succeed.  Presumably it can, if people put enough effort into the
> code.  This is a separate issue from making the documentation
> (overall, all types) more accessible.

Pieter, I apologize for any misunderstanding. I only meant to open a
discussion. I actually didn't intend or propose to move zeromq.org
away from Wikidot. But, I was proposing quick and easy access to all
aspects of information regarding zeromq, what ever form that may take.

As for generating code base docs for contributer usage.. after running
a quick script to change comment tokens from '//' to '//!' in the
header files of my repo, I generated this first draft doc[1] from
doxygen. Click some links.. even without any other changes it's quite
useful to contributers, imo.



> -Pieter
> _______________________________________________
> zeromq-dev mailing list
> zeromq-dev at lists.zeromq.org
> http://lists.zeromq.org/mailman/listinfo/zeromq-dev

More information about the zeromq-dev mailing list