Re: Documentation day
- From: Philip Van Hoof <spam pvanhoof be>
- To: tinymail-devel-list gnome org
- Subject: Re: Documentation day
- Date: Sun, 29 Apr 2007 15:23:46 +0200
As preparation I altered almost all Tinymail's implementation files to
have full coverage of API documentation.
This means that every publicly exported function now has a gtk-doc API
documentation comment. Even the _get_type ones that'll return your
GType, yes. All of them.
Happy reading
On Sat, 2007-04-28 at 11:20 +0200, Philip Van Hoof wrote:
> I want to organise a documentation day.
>
> How do you people feel about that? It implies that at least some people
> join me at doing a few hours of improving, adding and fixing API
> documentation. After that maybe also improving the wiki trac code
> samples and adding some documentation to them too.
>
> Maybe two or three other guys? That would be enough to transform our
> documentation into something that is really a kick-ass good doc basis.
>
> I might get a student languages (yes, misses Tinne herself) joining us,
> so non-native English speakers are welcome too.
>
> I want the documentation to describe what the implementations must do,
> and what they must not do. So some technical background of tinymail is
> useful (but I will be available for questions, while you are
> documenting)
>
> Yes, no? Who?
>
>
--
Philip Van Hoof, software developer
home: me at pvanhoof dot be
gnome: pvanhoof at gnome dot org
http://www.pvanhoof.be/blog
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]