Commit Graph
727 Commits
Author SHA1 Message Date
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>

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 <[email protected]>

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
John Scipione 7ec9bf2f5a A few more small fixes, trying to go quick 2014-12-04 19:33:35 -05:00
John Scipione 9bd3dedfce Fix a bit of copy pasta in the locale docs 2014-12-04 19:23:47 -05:00
John Scipione 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
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
Adrien Destugues 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
François Revol 74f2b62e3c ARM: Mention an interesting page about floating point
There are so many options on ARM...
2014-11-01 01:09:21 +01:00
Stefano Ceccherini c804ffd3b7 Documentation: Fix typo in BString 2014-09-09 23:05:18 +02:00
Ithamar R. Adema 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
Adrien Destugues f4df6bfab7 BEntry::Unset doc: missing \fn, better description. 2014-08-23 17:37:33 +02:00
Alexander von Gluck IV ea28139d84 docs: Update opengl readme info 2014-08-19 10:39:23 -04:00
Alexander von Gluck IV 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
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