[LRUG] Writing Module Docs (RDoc?)

[Gareth Humphries]

Last time I got fed up with syslog (for muchly the same reasons), i used
syslog-ng instead.  It's still very sysloggy, but let's you do sensible
things like define your own facility.  Definitely not a holy grail, but much
better than syslog.
It has a much more flexible configuration system, though it takes a bit more
work to grok.


Date: Fri, 11 Feb 2011 10:32:06 +0000

> From: Ash Berlin <ash_lrug at firemirror.com>
> To: London Ruby Users Group <chat at lists.lrug.org>
> Subject: [LRUG] Writing Module Docs (RDoc?)
> Message-ID: <047870FD-0081-4408-AE1B-E22147626387 at firemirror.com>
> Content-Type: text/plain; charset="us-ascii"
>
> 'lo,
>
> I've just recently started a job doing Ruby as Dev/Ops and I finally got
> fed up enough with the built in Syslog library (specifically the limit on
> one prognam and one facility per process) to try and find something better.
>
> So first question: Is there a syslog library that isn't built on top of the
> core Syslog library? Although I did have a look around and couldn't find one
> that might just be because I was looking in the wrong places.
>
> Assuming there's not; my next question is can anyone point me at a good
> resource *for doc writers* on how to write rdoc? I found one or two guides
> on google a few nights ago but they weren't what I was expecting. I'm after
> something along the lines of: "Place comments here to get
> {class,module,file,method} documented. Comments look like this. Format codes
> are this"
>
> Any pointers?
>
> Noobily,
> Ash
> -------------- next part --------------
> An HTML attachment was scrubbed...
> URL: <
> http://lists.lrug.org/pipermail/chat-lrug.org/attachments/20110211/80bcb045/attachment-0001.htm
> >
>
> ------------------------------
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lrug.org/pipermail/chat-lrug.org/attachments/20110212/75f81992/attachment.html>