[openbeos] Re: Haiku Documentation
- From: Michael Phipps <mphipps1@xxxxxxxxxxxxxxxx>
- To: openbeos@xxxxxxxxxxxxx
- Date: Fri, 29 Jul 2005 23:03:28 -0400
I have a counter proposal for this.
Every class needs an example. Sure. But every class ALSO needs a test case. It
seems to me that you could do them both in the same code. The test code for
BButton, for example, should show extreme uses of the class. Many buttons,
different flags, configurations, etc. Wouldn't that be a perfect example of the
usage of the class, too? I also wouldn't put them in the book. They would be
the "alongside" examples.
On 2005-07-28 at 06:12:04 [-0400], Zenja Solaja wrote:
> One thing which I think every good documentation needs is
> **examples**. For most experienced developers, they use the BeBook
> more as a reference guide, where you only need a reminder of which argument
> does what. But for beginners, well, the water really is deep. Otherwise,
> your start looks very promising.
>
> Having examples (one example per class) should be sufficient. An opportunity
> for the lazy perhaps? (look, a pink elephant, he shouts while diving behind
> cover ).
>
> Also, has anyone thought of making the HaikuBook a WikiPage, where anyone can
> contribute / edit data? That will definately solve the
> *old* documentation problem which plagues many projects. Plus you can
> have links to actual code examples. (eg. like
> http://gpwiki.org/index.php/Main_Page - the game programming wiki). All you
> need to do is export the latest wikipage to disk when releasing every Haiku
> update.
Other related posts:
