Commit Graph
114 Commits
Author SHA1 Message Date
Augustin Cavalier c86c9e29d3 ScrollView docs: make parameter name match the header file. 2015-02-27 02:39:07 -05:00
Augustin Cavalier aa01bfe571 Haiku Book: fix some typos.
The possessive form of "it" is "its", not "it's" ("it's" is just
shorthand for "it is").

Closes #11712.
2015-02-11 19:04:38 -05:00
John Scipione d04b3b772c Remove trailing . from titles 2015-01-27 19:15:11 -05:00
Adrien Destugues 6aa4d138bf LayoutBuilder: document C++ method chaining behavior
Fixes #8515.
2015-01-07 17:29:35 +01:00
Augustin Cavalier c09cca4a79 BSize docs: fix description of B_SIZE_UNSET.
Thanks Ingo for noticing!
2015-01-07 15:34:49 +01:00
Augustin Cavalier ab00c90d87 Create docs for BSize class.
Fixes #11713.

Signed-off-by: Adrien Destugues <[email protected]>
2015-01-07 08:29:33 +01:00
John Scipione 4536c6033b Update BToolTip class docs, added credit.
with remarks from Axel and PulkoMandy, thanks guys.
2015-01-02 18:15:25 -05:00
John Scipione d87c6913ec Add preliminary BToolTip docs 2014-12-23 17:32:05 -05:00
John Scipione d3c4833514 Some more small documentation fixes 2014-12-19 19:58:14 -05:00
John Scipione 5ebeb710ab B_WIDTH_FROM_LABEL was not available until BeOS R5 2014-12-19 19:51:46 -05:00
John Scipione ce3da8de9f Add docs for BTab and BTabView 2014-12-19 19:51:44 -05:00
John Scipione a28ddb79ec A few minor fixes to BTextControl docs 2014-12-19 19:51:39 -05:00
John Scipione d78a330deb Add BTextControl docs 2014-12-18 20:46:30 -05:00
John Scipione 95faf2ce54 Minor doc changes 2014-12-18 20:45:25 -05:00
John Scipione a03f66b7fb Fix a few errors in the nascent BOptionPopUp docs 2014-12-15 21:14:47 -05:00
Adrien Destugues 244f97dc27 LayoutItem: better documentation for SetExplicitMinSize.
This is a bit counter-intuitive, at least to me, as forcing the minimal
size can lead to the item being smaller than it would otherwise.
2014-12-15 10:46:11 +01:00
Adrien Destugues 9f9d972f79 Minimal documentation for BOptionPopUp.
This was available in R5 but somehow went missing from our version of
the Be Book (it is documented in the release notes in Tycom Systems
version). Document the more important methods of it, at least.
2014-12-08 14:38:09 +01:00
John Scipione 459706ee4d Update BView and BStringView docs
... based on Adrien's suggestions.

* Add \warning back to BView::ResizeToPreferred(), add \remark to highlight
  methods only appropriate to use as part of a BLayout.
* Clarify BView::SetFont() method and refer to BFont docs.
* Clarify BStringView::SetText(), Text(), and Draw().
* add field descriptions for BStringView::Instantiate().
2014-12-05 20:35:40 -05:00
John Scipione 02e24cdbfd StringView docs, capitalize T 2014-12-04 19:12:45 -05:00
John Scipione a3a2f89ec6 Tiny fix to StringView docs 2014-12-04 18:24:04 -05:00
John Scipione 44bcfa5d3b Add BStringView class docs 2014-12-04 17:57:11 -05:00
John Scipione 13c789f6c0 A few updates to the BView docs (needed for BStringView) 2014-12-04 17:56:53 -05:00
John Scipione 18842fc23e Add newline to end of BShape docs 2014-07-14 19:16:06 -04:00
John Scipione cb65c3a037 Document BShape and BShapeIterator 2014-07-14 19:03:20 -04:00
John Scipione 22da33b202 Add a few missing \fn's to BFont docs 2014-07-14 19:02:12 -04:00
John Scipione 425871d3af Update BWindow::Zoom() docs 2014-07-02 11:09:31 -04:00
Adrien Destugues 33d60fa21f BRegion: add ScaleBy(BSize) and user documentation. 2014-06-19 19:23:31 +02:00
John Scipione 47852bff02 IK documentation update
* Add \since directive to each method.
* Add documentation for BScrollBar and BScrollView classes.
* Title Case group titles.
* Some other minor documentation updates.
2014-06-13 17:44:22 -04:00
John Scipione 819863d8a9 Docs: Put a comma in Haiku, Inc. in the copyright. 2014-06-04 11:58:08 -04:00
John Scipione daabbbe5f9 BRegion: Style fix, update parameter name
No functional change.

Trying to indentify each kind of object uniquely and consistently.

... update docs as well.
2014-06-04 11:58:07 -04:00
John Scipione d0d41a229a Add BRegion documentation.
Most was written by Stephan Aßmus, and Stefano Ceccherini.
(moved from Region.cpp)

Thank you both for your contributions.
2014-06-03 20:28:44 -04:00
Andrew Lindesay b4c773d32e modified layout intro docsZ
Signed-off-by: John Scipione <[email protected]>
2014-06-02 20:13:16 -04:00
Adrien Destugues f31bb74725 ConstrainClippingRegion does not transform.
Document the fact that the region-based clipping does not use the view
transform. Also hint to a way to constrain drawing to a transformed
region.
2014-06-02 14:55:23 +02:00
John Scipione f90a92fdb2 Add documentation for the BRect class 2014-05-30 19:32:15 -04:00
John Scipione b03e8ffe7f Update BButton docs.
Document some old missing methods, but more importantly
document the new methods added by Ingo recently.
2014-05-28 14:21:23 -04:00
John Scipione 0a813c73fe Add documentation for BRadioButton. 2014-05-28 14:20:59 -04:00
John Scipione 274571d8a9 BCheckBox doc updates.
Many missing methods added.
2014-05-28 14:09:56 -04:00
John Scipione 78615023ce BControl docs update. 2014-05-28 14:05:45 -04:00
John Scipione 9c244999df Update BView docs, especially MouseMoved() 2014-05-28 12:14:43 -04:00
John Scipione 8c2c52ff67 BView docs: move description up, few updates. 2014-05-28 12:14:09 -04:00
John Scipione cbb1537fa2 Add documentation for BPolygon class. 2014-05-21 16:15:13 -04:00
John Scipione 30275c3f99 Add BPoint documentation. 2014-05-20 16:01:37 -04:00
John Scipione 18d4375e7c Fill out documentation for BPictureButton class. 2014-05-19 20:13:39 -04:00
John Scipione 03608f354a Fill out documentation for BPicture class. 2014-05-19 20:13:38 -04:00
John Scipione ae63d4aa97 Tiny change to the BListItem docs (make more generic) 2014-03-07 13:55:44 -05:00
John Scipione a003ac003f Add BStringItem docs 2014-03-07 13:55:43 -05:00
John Scipione c2db663cdf Add skeleton docs for BPicture and BPictureButton 2014-03-07 13:55:42 -05:00
John Scipione 6283e77947 BSeparatorItem: horizontal, not vertical line 2014-03-04 14:34:43 -05:00
John Scipione 5d10a74cfb BSeparatorItem: Style fix, rename archive to data
... missed it in a few places, trying to make variables names consistent.

Update hrev in docs
2014-03-04 14:28:20 -05:00
John Scipione 379ede58af Style fixes to BMenuItem::GetContentSize and update docs
Rename width and height to _width and _height matching the header.

Update the documentation for this method as well.
2014-03-04 14:17:46 -05:00