9bf7584d96
Add BInvoker docs
2015-01-15 15:30:23 -05:00
c50131cd6a
Complete and rework BJoystick docs.
2015-01-10 11:44:58 +01:00
c8e6696716
Add documentation for the Open method in the joystick class.
2015-01-10 11:31:02 +01:00
6aa4d138bf
LayoutBuilder: document C++ method chaining behavior
...
Fixes #8515 .
2015-01-07 17:29:35 +01:00
c09cca4a79
BSize docs: fix description of B_SIZE_UNSET.
...
Thanks Ingo for noticing!
2015-01-07 15:34:49 +01:00
ab00c90d87
Create docs for BSize class.
...
Fixes #11713 .
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
2015-01-07 08:29:33 +01:00
29b7900ec8
Add BJoystick docs to the Haiku Book.
2015-01-06 15:58:50 +01:00
70916faa5d
Add documentation for BJoystick::CountDevices
...
Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
2015-01-06 15:58:45 +01:00
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
70dc2e27e9
Add BTranslatorRoster documentation
2015-01-03 01:20:35 +01:00
b9e01b33ed
Fixup BTranslator documentation
2015-01-03 01:20:28 +01:00
02bdb5db9a
Add libtranslation group definition to doxygen stuff
2015-01-03 01:05:27 +01:00
4536c6033b
Update BToolTip class docs, added credit.
...
with remarks from Axel and PulkoMandy, thanks guys.
2015-01-02 18:15:25 -05:00
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
d7c90b6275
Add doxygen file for BTranslator class.
...
By Markus Himmel (GCI2014).
2014-12-30 04:54:19 +01:00
d87c6913ec
Add preliminary BToolTip docs
2014-12-23 17:32:05 -05:00
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
d3c4833514
Some more small documentation fixes
2014-12-19 19:58:14 -05:00
5ebeb710ab
B_WIDTH_FROM_LABEL was not available until BeOS R5
2014-12-19 19:51:46 -05:00
ce3da8de9f
Add docs for BTab and BTabView
2014-12-19 19:51:44 -05:00
a28ddb79ec
A few minor fixes to BTextControl docs
2014-12-19 19:51:39 -05:00
d78a330deb
Add BTextControl docs
2014-12-18 20:46:30 -05:00
95faf2ce54
Minor doc changes
2014-12-18 20:45:25 -05:00
a03f66b7fb
Fix a few errors in the nascent BOptionPopUp docs
2014-12-15 21:14:47 -05:00
71f6259a0f
Fix locale docs as suggested by Adrien, more work still needed
2014-12-15 21:12:54 -05:00
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
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
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
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
6db90d17a1
Fix BMimeType::SetIconForType() docs
2014-12-04 19:55:40 -05:00
7ec9bf2f5a
A few more small fixes, trying to go quick
2014-12-04 19:33:35 -05:00
9bd3dedfce
Fix a bit of copy pasta in the locale docs
2014-12-04 19:23:47 -05:00
4a31c32620
Update locale docs to match new reality.
...
Created docs for NumberFormat, DateFormat, DateTimeFormat, and TimeFormat
and moved the docs from BLocale to the respective new file. Also
DurationFormat was updated as well.
doxygen once again compiles the docs without warnings.
2014-12-04 19:13:46 -05:00
02e24cdbfd
StringView docs, capitalize T
2014-12-04 19:12:45 -05:00
a3a2f89ec6
Tiny fix to StringView docs
2014-12-04 18:24:04 -05:00
44bcfa5d3b
Add BStringView class docs
2014-12-04 17:57:11 -05:00
13c789f6c0
A few updates to the BView docs (needed for BStringView)
2014-12-04 17:56:53 -05:00
83b1a68c52
Move NetFS to a package
...
This is based on Jalopeura's patch to #10191 , however, there are some
changes.
From the patch:
* Make userlandfs use separate "interface definition" files for each
filesystem, so the netfs package can provide a configuration file
* Add a short document on how to use NetFS
* Various fixes to netfs to make it build again (volatile atomics)
* The netfs_mount script for easier use of NetFS
Additional fixes:
* Move netfs_mount and the interface description file to data/ in the
source tree
* Use strlcat instead of strcat to avoid a buffer overflow
* Some parts were already applied in previous commits
2014-11-17 15:24:07 +01:00
74f2b62e3c
ARM: Mention an interesting page about floating point
...
There are so many options on ARM...
2014-11-01 01:09:21 +01:00
c804ffd3b7
Documentation: Fix typo in BString
2014-09-09 23:05:18 +02:00
f1d7e394e4
ARM: update TODO list once again
...
* stackcrawl is implemented
* B_MAX_CPU_COUNT is no more
* add some bootloader TODOs
2014-09-07 21:14:23 +02:00
f4df6bfab7
BEntry::Unset doc: missing \fn, better description.
2014-08-23 17:37:33 +02:00
ea28139d84
docs: Update opengl readme info
2014-08-19 10:39:23 -04:00
4662c8c0a9
docs: opengl. Add some great documentation provided by Roudolf.
...
* Posted to the haiku-appserver ML, circa 2005.
* Covers a lot of intended uses of Be's accelerant API's in
depth and compares them to moden cards
2014-08-19 10:28:53 -04:00
18842fc23e
Add newline to end of BShape docs
2014-07-14 19:16:06 -04:00
cb65c3a037
Document BShape and BShapeIterator
2014-07-14 19:03:20 -04:00
22da33b202
Add a few missing \fn's to BFont docs
2014-07-14 19:02:12 -04:00
8546c4160e
BPositionIO: Add {Read,Write}AtExactly()
...
Analoguous to {Read,Write}Exactly(), just for the *At() versions.
2014-07-12 15:40:21 +02:00
ba88ee2be4
Allow ol's to show numbers
2014-07-02 11:11:57 -04:00
425871d3af
Update BWindow::Zoom() docs
2014-07-02 11:09:31 -04:00
b773d89eba
BDataIO: Add Flush()
2014-06-30 21:55:40 +02:00
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
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
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
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
79c6af799c
BString docs: Remove extra "to" in AppendChars() string param
...
Thanks stippi for noticing this oversight.
2014-06-25 15:39:07 -04:00
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
2ea139b8a3
BString docs: Document undocumented methods
2014-06-24 20:45:51 -04:00
c4b9309a99
Update Support Kit docs, add \since
...
Also add preliminary documentation for BObjectList.
2014-06-24 19:30:54 -04:00
0d8b44e25b
BDataIO: Add methods {Read,Write}Exactly()
2014-06-23 22:58:15 +02:00
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
33d60fa21f
BRegion: add ScaleBy(BSize) and user documentation.
2014-06-19 19:23:31 +02:00
5732a55917
A couple of small fixes to FindDirectory docs
2014-06-19 12:25:54 -04:00
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
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
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
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
dd3b190b55
Update Game Kit docs.
...
Add \since to each method.
2014-06-11 16:45:07 -04:00
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
1c52b28f3e
Add styling for \since command
2014-06-11 16:25:32 -04:00
819863d8a9
Docs: Put a comma in Haiku, Inc. in the copyright.
2014-06-04 11:58:08 -04:00
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
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
b4c773d32e
modified layout intro docsZ
...
Signed-off-by: John Scipione <jscipione@gmail.com>
2014-06-02 20:13:16 -04:00
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
f90a92fdb2
Add documentation for the BRect class
2014-05-30 19:32:15 -04:00
e0405a5615
Update userguide translations
2014-05-31 00:02:52 +02:00
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
0a813c73fe
Add documentation for BRadioButton.
2014-05-28 14:20:59 -04:00
274571d8a9
BCheckBox doc updates.
...
Many missing methods added.
2014-05-28 14:09:56 -04:00
78615023ce
BControl docs update.
2014-05-28 14:05:45 -04:00
9c244999df
Update BView docs, especially MouseMoved()
2014-05-28 12:14:43 -04:00
8c2c52ff67
BView docs: move description up, few updates.
2014-05-28 12:14:09 -04:00
cbb1537fa2
Add documentation for BPolygon class.
2014-05-21 16:15:13 -04:00
30275c3f99
Add BPoint documentation.
2014-05-20 16:01:37 -04:00
18d4375e7c
Fill out documentation for BPictureButton class.
2014-05-19 20:13:39 -04:00
03608f354a
Fill out documentation for BPicture class.
2014-05-19 20:13:38 -04:00
076b4544e1
Add some links to the allwinner A10 docs.
2014-05-01 18:47:23 +02:00
5b172de123
Update some docs for the ARM port.
...
* Add info on Allwinner A10 SOCs, which may be a worthwile target.
* Add info about the Linaro QEmu for emulating the BeagleBoard.
* Add more TODOs for PM aftermath.
2014-04-28 22:24:04 +02:00
1274874d1d
docs: Cleanup beagle documentation a little
2014-04-27 17:03:53 -05:00
e795d95872
Update userguide
2014-04-05 18:48:32 +02:00
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
ae63d4aa97
Tiny change to the BListItem docs (make more generic)
2014-03-07 13:55:44 -05:00
a003ac003f
Add BStringItem docs
2014-03-07 13:55:43 -05:00
c2db663cdf
Add skeleton docs for BPicture and BPictureButton
2014-03-07 13:55:42 -05:00
6283e77947
BSeparatorItem: horizontal, not vertical line
2014-03-04 14:34:43 -05:00
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
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
9b39e22db2
Add BSeparatorItem class documentation
2014-03-04 14:15:45 -05:00
6c594640f6
Document the BMenuItem class in the Haiku Book.
2014-02-28 19:05:34 -05:00
John Scipione