[B.A.T.M.A.N.] Creating alfred code documentation

[B.A.T.M.A.N.] Creating alfred code documentation

[Germano Massullo]

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.

Have a nice day

[1]: https://www.kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt

Re: [B.A.T.M.A.N.] Creating alfred code documentation

[Sven Eckelmann]

[-- 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 --]

Re: [B.A.T.M.A.N.] Creating alfred code documentation

[Germano Massullo]

[-- Attachment #1.1: Type: text/plain, Size: 531 bytes --]

Il 12/03/2016 18:55, Sven Eckelmann ha scritto:
> I am currently not sure about the "explaining also most important
> local variables" 

For example in the function

=========

static int vis_read_answer(struct globals *globals)
{
	const struct vis_print_ops *ops;
	struct vis_v1 *vis_data;
	uint16_t len;
	struct vis_iface *ifaces;
	struct vis_entry *vis_entries;
// CUT


=========
I would stress the purposes description of
struct vis_v1 *vis_data
struct vis_iface *ifaces
struct vis_entry *vis_entries


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [B.A.T.M.A.N.] Creating alfred code documentation

[Germano Massullo]

Hi, I want to tell that I have not forgotten the task, but I have been
very busy during past months :-)
I think to resume the work in autumn :-)