[openbeos] Re: First draft of the API documentation guidelines
- From: "Waldemar Kornewald" <wkornewald@xxxxxxxxxxxx>
- To: openbeos@xxxxxxxxxxxxx
- Date: Wed, 21 Mar 2007 15:45:07 +0100
On 3/21/07, Ingo Weinhold <bonefish@xxxxxxxxxxxxxxx> wrote:
The BeBook features quite a bit of introducing text for most classes,
including use cases and examples. If we do the same -- and I'd consider
this a good idea -- those parts of the documentation are good candidates
for separate files, but the more concise parts can as well live in the
source files, IMHO.
Agreed.
Bye,
Waldemar Kornewald
- References:
- [openbeos] Re: First draft of the API documentation guidelines
- From: Axel Dörfler
- [openbeos] Re: First draft of the API documentation guidelines
- From: Ingo Weinhold
Other related posts:
- » [openbeos] First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
- » [openbeos] Re: First draft of the API documentation guidelines
The BeBook features quite a bit of introducing text for most classes, including use cases and examples. If we do the same -- and I'd consider this a good idea -- those parts of the documentation are good candidates for separate files, but the more concise parts can as well live in the source files, IMHO.
- [openbeos] Re: First draft of the API documentation guidelines
- From: Axel Dörfler
- [openbeos] Re: First draft of the API documentation guidelines
- From: Ingo Weinhold