Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
51,087 Commits 9 Branches 0 Tags 473 MiB
82d9f9d119
Commit Graph

341 Commits

Author SHA1 Message Date
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
Ingo Weinhold
8546c4160e BPositionIO: Add {Read,Write}AtExactly() 
Analoguous to {Read,Write}Exactly(), just for the *At() versions.
 2014-07-12 15:40:21 +02:00
John Scipione
ba88ee2be4 Allow ol's to show numbers 2014-07-02 11:11:57 -04:00
John Scipione
425871d3af Update BWindow::Zoom() docs 2014-07-02 11:09:31 -04:00
Ingo Weinhold
b773d89eba BDataIO: Add Flush() 2014-06-30 21:55:40 +02:00
John Scipione
955ace81fd Move the search text box to the right 
The "API DOCUMENTATION" text placement corresponds similar text in the
User Guide.
 2014-06-30 15:22:53 -04:00
Augustin Cavalier
67e4499bbe Add search function to the API docs. 
* Uses Google site search.
 * CSS taken from the User Guide Translator's CSS.

Signed-off-by: John Scipione <jscipione@gmail.com>
 2014-06-30 15:22:52 -04:00
John Scipione
5b55bbb0a6 BString docs: Add docs for StartsWith() and EndsWith() 
I'm not sure why these method docs got skipped, they are
nice to know about.
 2014-06-30 14:50:20 -04:00
John Scipione
798a273725 BString docs: Fix a bunch of other stuff. 
A lot of clarification.

Also, sometimes "the object" was used to refer to the BString you're doing
stuff to and sometimes "the BString" was used, settle on "the BString".
 2014-06-25 15:39:08 -04:00
John Scipione
79c6af799c BString docs: Remove extra "to" in AppendChars() string param 
Thanks stippi for noticing this oversight.
 2014-06-25 15:39:07 -04:00
John Scipione
e0016ffde9 Style fixes to BRoster, move docs to doxygen. 
Keep the brief description as a regular comment above each public method.

Leave the docs of private methods.

Some variable renaming mostly because of abbreviations.

Add documentation for all the public methods and app_info members and defines
that didn't have docs in the cpp file.
 2014-06-25 15:35:09 -04:00
John Scipione
2ea139b8a3 BString docs: Document undocumented methods 2014-06-24 20:45:51 -04:00
John Scipione
c4b9309a99 Update Support Kit docs, add \since 
Also add preliminary documentation for BObjectList.
 2014-06-24 19:30:54 -04:00
Ingo Weinhold
0d8b44e25b BDataIO: Add methods {Read,Write}Exactly() 2014-06-23 22:58:15 +02:00
Ingo Weinhold
98759fe6e6 BDataIO: Provide default implementations for Read()/Write() 
This makes the interface somewhat more suitable for unidirectional use,
since one doesn't have to implement the other, not needed method.
 2014-06-23 22:58:14 +02:00
Adrien Destugues
33d60fa21f BRegion: add ScaleBy(BSize) and user documentation. 2014-06-19 19:23:31 +02:00
John Scipione
5732a55917 A couple of small fixes to FindDirectory docs 2014-06-19 12:25:54 -04:00
John Scipione
5efee6dfb0 NodeMonitor: Revert enums back to #defines 
While enums are presented much more clearly in the docs and the values didn't
change this apparently caused some issues so we're going back to using #defines.

Also update the docs changing the \var tags to \def tag and putting the description
in a \brief tag.
 2014-06-18 20:57:49 -04:00
John Scipione
b885e90eb9 Documentation updates for Storage Kit classes 
* Added \since to each method and parameter.
* Whitespace cleanup.
* Some other minor cleanups and updates.
 2014-06-18 19:41:14 -04: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
edc845a323 Update Locale Kit docs. 
Add \since to each method. This was pretty easy to figure out since
the whole kit exists only in Haiku.
 2014-06-11 16:48:17 -04:00
John Scipione
dd3b190b55 Update Game Kit docs. 
Add \since to each method.
 2014-06-11 16:45:07 -04:00
John Scipione
ac9714d8a4 Update App Kit Documentation. 
The biggest change is the addition of \since to each method. I've gone
through old versions of the BeBook and documented what version of BeOS
each method was introduced in. I'm only counting production releases
so I'm starting with BeOS R3 ignoring all DR and PR releases. Likewise,
all methods new to Haiku are listed as being introduced \since Haiku R1
ignoring alpha releases.
 2014-06-11 16:25:57 -04:00
John Scipione
1c52b28f3e Add styling for \since command 2014-06-11 16:25:32 -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
Axel Dörfler
c8127e2b7d DatagramSocket.dox: fixed ReceiveFrom() description. 
* Please read other documentation and code before trying to write any
  documentation for Haiku. While any effort to improve our documentation
  is welcome, adding non-sense to it is harmful. Writing proper
  documentation is hard.
* Fixed spelling in a number of cases.
* Please don't write method names without (). Please use \a and \c to
  mark the text accordingly.
 2014-03-26 23:47:08 +01: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