public inbox for b.a.t.m.a.n@lists.open-mesh.org
 help / color / mirror / Atom feed
From: Sven Eckelmann <sven@narfation.org>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: Re: [B.A.T.M.A.N.] Creating alfred code documentation
Date: Sat, 12 Mar 2016 18:55:47 +0100	[thread overview]
Message-ID: <1817507.YIectHPgqy@sven-edge> (raw)
In-Reply-To: <CAGa=++Q48GRsxuqchoWqsgjxz020eyRub0+vertAN2brzRy3HA@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 847 bytes --]

On Saturday 12 March 2016 17:12:19 Germano Massullo wrote:
> Hi, it's Germano from Ninux.org community.
> For personal purposes, I am commenting vis.c/vis.h alfred code, at the
> beginning of each function, explaining also most important local
> variables (keeping in mind documentation guidelines [1])
> I would like to know if you are interested in such documentation
> process. If yes, I could extend this kind of work to the whole alfred
> code.

Sounds great. I am currently not sure about the "explaining also most
important local variables" part but maybe you just do the vis.c/.h and then
submit it as patch(es) [1]. This way we can discuss it on an actual example
before you crawl through the complete alfred(-vis|-gpsd) codebase.

Kind regards,
	Sven

[1] https://www.open-mesh.org/projects/open-mesh/wiki/Contribute#Submitting-patches


[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

  reply	other threads:[~2016-03-12 17:55 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-03-12 16:12 [B.A.T.M.A.N.] Creating alfred code documentation Germano Massullo
2016-03-12 17:55 ` Sven Eckelmann [this message]
2016-03-14 21:50   ` Germano Massullo
2016-09-30  5:38   ` Germano Massullo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1817507.YIectHPgqy@sven-edge \
    --to=sven@narfation.org \
    --cc=b.a.t.m.a.n@lists.open-mesh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox