Opened 5 years ago

Last modified 5 years ago

#15654 new enhancement

Stabilize and Document: BStripeView — at Version 2

Reported by: kallisti5 Owned by: nobody
Priority: normal Milestone: Unscheduled
Component: Kits/Interface Kit Version: R1/Development
Keywords: easy Cc:
Blocked By: Blocking:
Platform: All

Description (last modified by nielx)

StripeView was added to Haiku in hrev53153 (66cb2efa)

It's in the Shared kit... to be honest, I don't see any documentation for anything in the Shared kit.

https://www.haiku-os.org/docs/api/

This might be a good start.

Note nielx: this should IMO be documented the moment it is stabilized and gets added to the general API.

Change History (2)

comment:1 by pulkomandy, 5 years ago

The "shared kit" is for semi-private things which don't have a stable ABI yet. So maybe we should start the documentation by explaining that, and what it means for people using it.

comment:2 by nielx, 5 years ago

Component: DocumentationKits/Interface Kit
Description: modified (diff)
Owner: changed from nielx to nobody
Summary: Document: Create documentation for BStripeViewStabilize and Document: BStripeView

Moving to unscheduled. While I am not documenting experimental APIs, I do think that anything that is not in the public headers is really not ready for consumption yet.

If this ever becomes public API, part of that decision (and commit) should be to add the documentation. I will actually take the liberty to rescope this issue and make it 'Stabilize and document BStripeView', though I am open to other interpretations.

Note: See TracTickets for help on using tickets.