Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
61,992 Commits 9 Branches 0 Tags 473 MiB
5a6d68bbfa
Commit Graph

166 Commits

Author SHA1 Message Date
Michael Lotz
0bba9b9752 Fix some typos and whitespace in BLayout docs. 2015-04-15 00:30:55 +02:00
Augustin Cavalier
906283b6d6 Haiku Book: Make the layout introduction somewhat more professional. 2015-03-25 11:47:29 -04:00
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 <pulkomandy@gmail.com>
 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 <jscipione@gmail.com>
 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
John Scipione
9b39e22db2 Add BSeparatorItem class documentation 2014-03-04 14:15:45 -05:00
John Scipione
6c594640f6 Document the BMenuItem class in the Haiku Book. 2014-02-28 19:05:34 -05:00
John Scipione
46f5821ad1 Add docs for BOutlineListView class 2013-12-11 16:15:15 -05:00
John Scipione
853f724631 Minor updates to BListView docs 2013-12-11 16:13:12 -05:00
John Scipione
7192a9313e Add documenation for BPopUpMenu class 2013-11-11 19:28:04 -05:00
John Scipione
24be9ac7fd Update SetRadioMode() method to descibe radio mode 2013-11-11 19:27:13 -05:00
John Scipione
0096a29e9c Add BMenuField class documentation 2013-11-08 19:29:13 -05:00
John Scipione
d7d2ff5bde Minor updates to the BMenu and BMenuBar classes. 
Remove the reimplemented hook methods groups because some
hook methods are there, some are not, unfortunately doxygen can’t
tell if a hook method just calls the default or does something else and
we tend to include all the hook methods even if we don’t actually make
any functional changes to them making the docs a bit more verbose
than they otherwise would be.
 2013-11-08 19:29:13 -05:00
John Scipione
a676c40c3e Some minor updates to BControl docs. 2013-11-08 19:29:12 -05:00
John Scipione
8b4655091d More minor updates to the BView docs. 2013-11-08 19:29:12 -05:00
John Scipione
34ce2cefc8 BMenuBar docs, silly mistake 2013-11-06 19:35:01 -05:00
John Scipione
ed7c19b5ef Added BMenuBar docs. 2013-11-06 19:26:34 -05:00
John Scipione
0d635255f5 Minor updates to BMenu docs. 
Added an Archive() method description.
 2013-11-06 19:23:48 -05:00
John Scipione
45e17d3d42 Update BView::DrawAfterChildren() param name 
... from r to updateRect, no functional change intended.

Also a tiny change to the param description in the docs.
 2013-11-06 13:14:53 -05:00
John Scipione
2f746eafdc Add BMenu documentation 2013-11-06 12:21:58 -05:00
John Scipione
45b87db2b7 A few minor updates to the BView docs 2013-11-06 12:21:57 -05:00
John Scipione
31005da9b8 Update BWindow shortcut docs 2013-10-20 15:51:34 -04:00
Adrien Destugues
6ec9625a36 Fix mismatched prototypes in the Haiku Book. 2013-10-04 16:56:59 +02:00
John Scipione
e9eb899aa4 BFont docs: Update SetEncoding() with some new info 2013-08-25 21:36:50 -04:00
John Scipione
f59d62ffd3 Add BWindow documentation 2013-07-26 18:36:17 -04:00
John Scipione
080bf8fe19 Fix rest of warnings, doxygen now runs cleanly. 
The BTextView::SetText() methods were included twice, update the first and
remove the second.
 2013-07-08 19:30:45 -04:00
John Scipione
e724b26f23 Remove enum elaborated type specifier 
...from orientation params. Elaborated type specifiers are not needed
for C++ code and removing them makes doxygen happy. Verified working
on both gcc2h and gcc4h builds.
 2013-07-08 19:29:11 -04:00
John Scipione
27929dcd1d BView docs: Add remaining new method descriptions 
Layout and Tool Tip method documentation.

Also ScrollWithMouseWheelDelta()
 2013-06-28 23:18:55 -04:00
John Scipione
468559e46d Update BView docs for changes in hrev45799 2013-06-28 23:12:38 -04:00
John Scipione
dd84193fa4 Begin filling out the detailed description 2013-06-28 20:28:45 -04:00
John Scipione
1126023668 Fill out the constructor docs. 2013-06-28 20:28:43 -04:00
John Scipione
2891821fde Fill out the BView docs 
* Fill out the Input related method descriptions and also some other updates
  to method and variable descriptions.
* Document Graphics State Methods and a bunch of Drawing Related Methods
* Add a bunch more drawing method descriptions.
* Fill out the rest of the methods of the BView class.
 2013-06-28 20:28:32 -04:00
John Scipione
8fc951cebb BFont docs: Clarify escapement_delta language. 
Make it clear that the values provided by the escapement_delta struct are an
input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
 2013-06-13 14:35:03 -04:00
John Scipione
4cbcabff5f Add documentation for BListView and BListItem classes 2013-04-25 17:58:13 -04:00
John Scipione
2d5697e109 A few fixes to TextView.dox, \see BView::method() 2013-04-25 17:57:35 -04:00
John Scipione
d58ff0b187 Add BTextView class docs 2013-03-16 17:22:56 -04:00
John Scipione
ca9a59bbc5 add a newline 2013-03-16 17:04:44 -04:00
John Scipione
131261d2b5 Remove remaining /trunk/ before file references. 2013-02-07 21:19:06 -05:00
John Scipione
a93a16151d Fix doxygen warnings, enums can only be in 1 group 2013-02-07 15:52:07 -05:00
John Scipione
820dca4df6 Big docs cleanup. 
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, email@domain.com not name <email@domain.com>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
 2013-02-07 02:01:19 -05:00
John Scipione
6a4b222bc9 Use condensed, not squished together. Better 2013-01-19 13:17:50 -05:00
John Scipione
4f7717a999 By removing the style on escapement_delta doxygen links it up which is better 2013-01-19 13:17:49 -05:00
John Scipione
27c3eae9b4 Another minor fix, style constant 2013-01-19 13:17:49 -05:00
John Scipione
0d2b04ca83 Minor update use fixed font for B_OK 2013-01-19 13:17:49 -05:00
John Scipione
05757eb6b3 Fill out BFont detailed description. 
Also a bunch of cleanup including removing private method docs
and cleaning up language. BFont is pretty much completely documented
at this point.
 2013-01-19 13:17:48 -05:00
John Scipione
c258d2fa0e Fill out BFont member docs 2013-01-19 13:17:47 -05:00
John Scipione
566e828c5f Add initial BFont documentation 2013-01-19 13:17:46 -05:00
John Scipione
ea468b9855 Add \brief tag so description appears in files table 2013-01-14 21:11:15 -05:00
John Scipione
f729cb8d48 Remove methods from CheckBox.dox that are not unique to the class fixing warnings 2012-12-21 22:51:19 -05:00
John Scipione
177942adc7 Remove documentation fro Button.dox that is not unique to BButton fixing a few warnings 2012-12-21 22:51:18 -05:00
John Scipione
e5f2a41917 Update revision, this matters because I changed the variables in the BDragger constructor. 2012-12-21 22:34:27 -05:00
John Scipione
a6ada82b00 Add BDragger class documentation 2012-12-21 22:31:29 -05:00
Alex Wilson
a84e14ca84 Merge branch 'master' of git://github.com/haiku/haiku 2011-12-15 20:50:28 -07:00