Finishing the Haiku Book

Development
1

Is there a way to help with the expansion of the Haiku Book documentation and inclusion of the still missing classes in the API to be documented, such as BShelf?

2 Likes
2

Sure. : )

Patches can be submitted here: https://review.haiku-os.org/q/status:open+-is:wip
(doc: Get the Haiku Source Code / Pushing Patches to Haiku 101 | Haiku Project)

Here are examples of commits that updated the documentation: https://cgit.haiku-os.org/haiku/log/docs/user

Feel free to CC me on any changes you submit to the documentation

2 Likes
3

I’ve done the draft file of BShelf. Meanwhile the situation with the account in Gerrit isn’t solved, I could continue with the documentation.

Should I do one for BColumnListView, or should I leave it undocumented because it is still inside the private API?

The input server wasn’t yet documented. Should it be under “Special topics”?

Looking at the R5 BeBook, this is not documented:

  • The whole “Device Kit”, including BJoystick and BSerialPort.
  • In the Game Kit: BGameSound, BPushGameSound, BSimpleGameSound, BStreamingGameSound, BWindowScreen, graphics card hook functions
  • The Input Server: BInputDevice, BInputServerDevice, BInputServerFilter, BInputServerMethod
  • In the Interface Kit: BPrintJob, BShelf (I’ve done this), BSlider (private under Haiku)
  • The “Kernel Kit” group of miscellaneous system related functions.
  • In the Mail Kit: BMailMessage, children of BMailComponent (BMailAttachment, BMailContainer, BEmailMessage), BMailDaemon, BMailSettings.
  • In the Media Kit: BBufferConsumer, BBufferGroup, BBufferProducer, BContinuousParameter, BControllable, BDiscreteParameter, BMediaAddOn, BMediaBufferDecoder, BMediaBufferEncoder, BMediaDecoder, BMediaEncoder, BMediaEventLooper, BMediaFile, BMediaFiles, BMediaFormats, BMediaNode, BMediaRoster, BMediaTheme, BMediaTrack, BNullParameter, BParameter, BParameterGroup, BParameterWeb, BSmallBuffer, BSoundPlayer, BTimeCode, BTimedEventQueue, BTimeSource, media and rt functions.
  • The Network Kit: BNetAddress BNetBuffer BNetDebug BNetEndpoint
  • Should the “OpenGL Kit” be considered here? If so, then BGLView.
  • The Translation Kit: BTranslationUtils, Translator add-ons
  • More about the legacy device drivers api.

That is also with the undocumented additions of Haiku to the public API.

4 Likes