[z88dk-dev] documentation

Bridge to the z88dk-developers mailing list
Post Reply
alvin
Well known member
Posts: 1872
Joined: Mon Jul 16, 2007 7:39 pm

[z88dk-dev] documentation

Post by alvin »

I hate doing it :P I wonder if anyone else wants to volunteer some time with writing it.

I'm working on documenting the library functions now in spare moments. That includes watching TV so some of the sentences written probably aren't perfect.

stdlib.h:
http://www.z88dk.org/wiki/doku.php?id=libnew:stdlib

malloc.h:
http://www.z88dk.org/wiki/doku.php?id=l ... loc_malloc

That's how I envisaged it looking but if you can do better feel free.

The documentation for the header files are linked from here:
http://www.z88dk.org/wiki/doku.php?id=t ... er_listing

Some of them are green because I've created the page and maybe put some functions in but they should be compared to the header files ( http://z88dk.cvs.sourceforge.net/viewvc ... MENT/sdcc/ ) and made consistent in appearance with the two headers above. I am using the C11 draft standard to organize the functions within a header ( http://z88dk.cvs.sourceforge.net/viewvc ... vision=1.1 )


The is the new C library documentation. I'm looking at moving the classic c library information onto the temp front page but I think I'll do that after the temp front page is changed to more of a table of contents so that the thing doesn't get so big you can't make heads or tails of it.

The documentation is the single biggest time consumer ahead of another release which is something I think is long overdue.



------------------------------------------------------------------------------
Post Reply