Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
53,532 Commits 9 Branches 0 Tags 473 MiB
162224b5d2
Commit Graph

404 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
51362d85d8 Haiku Book: Doxyfile: eat __attribute__ directives. 
Without this, Doxygen attempts to parse __attribute__ directives
and often outputs garbage instead of properly parsing them, so just
exclude them from the documentation.

Fixes some incorrect function listings in BString documentation
and possibly more elsewhere.
 2015-04-06 18:00:39 -04:00
Augustin Cavalier
64f7e980a4 BString docs: don't have tags in hsection titles. 2015-04-06 17:51:04 -04:00
Augustin Cavalier
906283b6d6 Haiku Book: Make the layout introduction somewhat more professional. 2015-03-25 11:47:29 -04:00
Augustin Cavalier
9d6780b587 Haiku Book: disable class diagrams. 
The last time this was discussed on the ML, the consensus was that
the text lists were nicer than the diagrams (with only one objection).
For the minority that wants class diagrams, it's easy enough to reverse
this one-line change.
 2015-03-25 11:37:10 -04:00
Augustin Cavalier
e6ecb3fc07 Haiku Book: Midi2 fixes. 
* Automatic whitespace cleanup.
 * Removed all of Midi2 from the "libbe" group, as they aren't part of it
 * Get rid of the redundant "libmidi2" group, as all of midi2 is already in
   the "MIDI 2 Kit" group, and the docs explicitly state that the MIDI 2 Kit
   has its own library.
 2015-03-25 11:30:01 -04:00
Augustin Cavalier
aa6ef6658c Haiku Book: fix device drivers group definition. 
Also removed the "Keyboard" group definition, which was broken. There
wasn't anything in that group, and there's only one page on the
keyboard anyway.
 2015-03-25 11:23:51 -04:00
Augustin Cavalier
c86c9e29d3 ScrollView docs: make parameter name match the header file. 2015-02-27 02:39:07 -05:00
Augustin Cavalier
4cb2c39774 Haiku Book: compatibility: list all authors at the top of the file as per convention. 
All of the other .dox files here list authors at the top of the file
in a standard (non-Doxygen) comment, so do the same here.

I've listed the file as copyright 2011, as (according to Git) that's
the last time it was functionally changed. I also added a few people
in as being authors of the file who seem to have made significant
changes to it.
 2015-02-11 19:14:20 -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
Augustin Cavalier
82d26eb239 Haiku Book: old Midi Kit: fix link to the BeBook. 
That online copy of the BeBook went offline some time ago, and we
now host one, so point to that instead.
 2015-02-11 19:00:18 -05:00
John Scipione
b1a9f638da Add preliminary Net Kit intro by Philippe Houdoin 
From here:
http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
 2015-01-27 19:16:54 -05:00
John Scipione
d04b3b772c Remove trailing . from titles 2015-01-27 19:15:11 -05:00
John Scipione
7177815b20 Use regular bullets for lists, matches User Guide 2015-01-27 19:14:36 -05:00
John Scipione
3cf6e692c8 Fix typos in BReferencable docs 2015-01-27 18:17:16 -05:00
Adrien Destugues
f6c0340128 Add documentation for BReference and BReferenceable. 2015-01-26 13:59:55 +01:00
John Scipione
a82d6bdd3e Replace 'should' with 'must' in BInvoker::SendMessage() docs 2015-01-22 13:43:45 -05:00
John Scipione
a66de90c49 Clarify BInvoker::SetMessage() docs some more 
The language on SetMessage() was still a bit confusing, this should
hopefully clear it up.
 2015-01-20 20:13:57 -05:00
Adrien Destugues
412f030b0f Some clarifications to BInvoker docs. 2015-01-17 13:41:55 +01:00
John Scipione
db7ef1292a Add BMessageRunner docs 2015-01-16 18:00:50 -05:00
John Scipione
2eb2dcfabe Small fixes to BMessenger docs 2015-01-16 17:59:48 -05:00
John Scipione
fd3c25a928 Move the operator function docs over too 2015-01-16 16:43:34 -05:00
John Scipione
973984649c Add BMessenger docs 2015-01-16 16:43:33 -05:00
John Scipione
19ce061e0b Update BInvoker docs to clarify them 
...with notes from PulkoMandy and Axel. Also added author credits.

Class documentation is moved to the appropriate method and then \sa
is used to point to the documentation so it is only documented in
one location.

Added some text about how the interaction between BInvoker and
BHandler and/or BLooper works.

BMessenger needs to be documented to understand how SetTimeout() is
suppose to work, refer to BeBook for now.
 2015-01-16 14:24:32 -05:00
John Scipione
23f1ce0756 BInvoker::Timeout was introduced in BeOS R5, not R3 2015-01-15 15:33:27 -05:00
John Scipione
9bf7584d96 Add BInvoker docs 2015-01-15 15:30:23 -05:00
Adrien Destugues
c50131cd6a Complete and rework BJoystick docs. 2015-01-10 11:44:58 +01:00
mandar
c8e6696716 Add documentation for the Open method in the joystick class. 2015-01-10 11:31:02 +01: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
Adrien Destugues
29b7900ec8 Add BJoystick docs to the Haiku Book. 2015-01-06 15:58:50 +01:00
mandar
70916faa5d Add documentation for BJoystick::CountDevices 
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
 2015-01-06 15:58:45 +01:00
Markus Himmel
70dc2e27e9 Add BTranslatorRoster documentation 2015-01-03 01:20:35 +01:00
Markus Himmel
b9e01b33ed Fixup BTranslator documentation 2015-01-03 01:20:28 +01:00
François Revol
02bdb5db9a Add libtranslation group definition to doxygen stuff 2015-01-03 01:05:27 +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
Markus Himmel
29608b033c Fix BTranslator documentation formatting 
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>

GCI2014 task https://www.google-melange.com/gci/task/view/google/gci2014/5830218824548352
 2014-12-30 22:28:19 +01:00
François Revol
d7c90b6275 Add doxygen file for BTranslator class. 
By Markus Himmel (GCI2014).
 2014-12-30 04:54:19 +01:00
John Scipione
d87c6913ec Add preliminary BToolTip docs 2014-12-23 17:32:05 -05:00
Adrien Destugues
207212972e BMessage: remove unimplemented GetPointer from headers and docs 
* This was never implemented and no one noticed until now.
* A default value for a pointer doesn't make that much sense anyway, so
using the FindPointer method is fine.
 2014-12-22 15:01:56 +01: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
John Scipione
71f6259a0f Fix locale docs as suggested by Adrien, more work still needed 2014-12-15 21:12:54 -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