Hola, 2007/4/26, Sevik <sevik9@xxxxxxxxx>:
I would also like to do small things in order to get my feet wet, and satisfy my own personal view of what should be in the docs :) As an example of something really small, I noticed that the BList::SortItems method doc didn't indicate the integer value that the compare function, which is passed to it, should return. While it may be obvious to many (although I doubt to new programmers), and an example with strings is just TWO clicks away, I think a description of the return value that is not string-specific would be appropriate.
Go for it!
Another aside, is there any particular reason why the copyright information is in a non-standard form? Normally, it would be: Copyright (C) 2007 Haiku, Inc. All rights reserved. Where (c) can also be a circle with a C in it -- © in HTML; and no comma after the year, and no caps on the 'rights reserved' part. Currently, we have: Copyright 2007, Haiku, Inc. All Rights Reserved.
I had a different copyright notice before this and changed it after Axel's suggestion. I picked a file I know would have been touched by Axel, however, it does not adhere to the set guidelines as defined by the code guidelines. The coding guidelines give the following: /* * Copyright 2004-2006 Haiku Inc. All rights reserved. * Distributed under the terms of the MIT License. */ So it's a middle way. I have updated the API guidelines to reflect this (unless there are compelling arguments for not doing it this way). Niels