Augustin Cavalier
32fab80eea
Revert "Delete old DiskUsage docs."
...
Apparently, upon reading the "fine print" at the bottom, these docs *must*
be distributed with the binaries.
Now to try to contact the author...
2015-02-11 22:02:24 -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
Augustin Cavalier
22440f4105
Delete old DiskUsage docs.
...
The DiskUsage docs in the Userguide have all of this info and then
some.
2015-02-11 18:44:29 -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
autonielx
ba483af7de
Update userguide translations
2015-01-17 18:26:48 +01: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
luroh
1d5b36cee2
Clean up FreeType outsourcing leftovers
...
- Remove obsolete FreeType docs
- Remove obsolete FreeType license
- Update FreeType license and copyrights in AboutSystem
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
Fixes #11697
2015-01-05 11:23:02 +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
Niels Sascha Reedijk
f36b3f9b3e
Generate the Makefile for making docsets.
...
Docset is an increasingly popular format that is used to generate
an index for HTML documentation that can be viewed by specialized
viewers such as Dash (on the Mac). The output can only be generated
on a Mac currently. Enabling the DOCSET parameter will generate a
Makefile in the html output directory, which can be used to generate
the Docset itself.
Enabling the Docset Makefile does not negatively impact other things,
as such it seems safe to just enable it for whoever wants to build
the docset on a mac.
2014-12-08 22:14:24 +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
6db90d17a1
Fix BMimeType::SetIconForType() docs
2014-12-04 19:55:40 -05:00
