haiku/docs/user
Adrien Destugues 4b0d8831c2 HaikuBook: better doc and example for BList::DoForEach
The description of the callback function was still quite confusing. The
main usage for the return argument from the callback function is not
handling failures, but knowing wether the function did something in the
list or not, and stopping the iteration if only one item was looked for.

Add an example use of the function return value to implement a linear
search in the list and remove the note about the function "failing",
which is not what this parameter was meant to do (and I think that lead
to the initial inversion of "true" and "false" values.

Change-Id: If8cae8b8ee21ced2c899aef6033a89ab8dbf1621
Reviewed-on: https://review.haiku-os.org/c/haiku/+/5339
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
Tested-by: Commit checker robot <no-reply+buildbot@haiku-os.org>
2022-05-26 07:49:01 +00:00
..
app Minor documentation fixes 2022-01-11 12:22:17 +00:00
device Complete and rework BJoystick docs. 2015-01-10 11:44:58 +01:00
drivers FS Interface Docs: Made read_dir description clear 2020-06-11 10:39:35 +00:00
game BFileGameSound docs: Fix typo 2020-07-07 19:20:48 +02:00
graphics Documentation: Added Accelerant documentation 2020-10-08 07:15:28 +00:00
interface Minor documentation fixes 2022-01-11 12:22:17 +00:00
keyboard Update keycodes image with more stylish version 2013-01-21 20:10:59 -05:00
locale BCountry: add a GetPreferredLanguage method. 2021-07-21 07:20:39 +00:00
mail Migrate the BTextMailComponent docs to the Haiku Book. 2017-12-26 13:59:25 -05:00
media Update BBuffer class docs. 2013-02-07 02:11:09 -05:00
midi Haiku Book: old Midi Kit: fix link to the BeBook. 2015-02-11 19:00:18 -05:00
midi2 Haiku Book: revert accidental overzealous search & replace all 2020-03-08 09:21:06 +00:00
net docs/user/net: add BUrlRequest documentation 2021-07-25 11:52:21 +00:00
netservices libbnetapi: BUrlRequest now outputs to BDataIO 2021-02-28 20:39:31 +00:00
posix HaikuBook: escape the # character as it implies a link request 2021-04-19 07:00:42 +01:00
ppp
shared HaikuBook: housekeeping of the netservices documentation 2021-01-29 09:56:28 +00:00
storage FindDirectory docs: clarify where the functions are located 2021-01-13 12:57:00 +01:00
support HaikuBook: better doc and example for BList::DoForEach 2022-05-26 07:49:01 +00:00
translation HaikuBook: fix warnings generated by Doxygen 1.18.16. 2020-03-08 08:57:37 +00:00
apidoc.dox HaikuBook: add instructions for including INTERNAL documentation 2020-10-11 15:46:06 +00:00
book.css HaikuBook: Apply layout customizations after default Doxygen stylesheet 2020-09-29 19:14:01 +00:00
book.dox Minor documentation fixes 2022-01-11 12:22:17 +00:00
compatibility.dox Haiku Book: compatibility: list all authors at the top of the file as per convention. 2015-02-11 19:14:20 -05:00
credits.dox
Doxyfile BString: add support for move semantics with C++11 and up. 2021-09-08 07:07:36 +00:00
footer.html HaikuBook: Apply layout customizations after default Doxygen stylesheet 2020-09-29 19:14:01 +00:00
header.html HaikuBook: Apply layout customizations after default Doxygen stylesheet 2020-09-29 19:14:01 +00:00
HOWTO Better to have consistent paths... 2011-02-18 12:32:18 +00:00
Makefile HaikuBook: Add Makefile that supports the default and the develop configurations 2020-10-11 15:46:06 +00:00