Commit Graph

636 Commits

Author SHA1 Message Date
Adrien Destugues
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
Alexander von Gluck IV
1274874d1d docs: Cleanup beagle documentation a little 2014-04-27 17:03:53 -05:00
autonielx
e795d95872 Update userguide 2014-04-05 18:48:32 +02: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
John Scipione
6c594640f6 Document the BMenuItem class in the Haiku Book. 2014-02-28 19:05:34 -05:00
John Scipione
847e14f002 Turn class diagrams back on 2014-02-27 17:36:57 -05:00
waddlesplash
dba29137b2 Tweaks to the API documentation
* Update the Doxyfile for 1.7.6.1. Doxywizard reformatted the comments; that's why this change is so big
  * Disable graph inheritance trees; use "Inherits/Inherited by" lists instead (Doxygen has this on by default; I don't think it was intentional)
  * Shorten two subgroup names; helps with formatting in Doxygen 1.8 and looks cleaner
  * Moves the page footer ("The Haiku Book pre-R1...") be in a <footer> tag, and add a CSS rule for this tag
  * Disable XML output, no one is using it
  * Disable Microsoft IDL parsing, speeds up Doxygen a bit
2014-02-27 17:21:51 -05:00
Alexander von Gluck IV
0ba833faa0 docs: Update arm build instructions; no functional change
* For a post PM world
2014-02-09 23:44:57 -06:00
Ingo Weinhold
c41356fab5 BAppFileInfo: Add method versions that don't touch the MIME DB
Add SetSupportedTypes() and SetIcon[ForType]() versions with an
additional bool updateMimeDB parameter. If false, the method doesn't
update the MIME DB entries for the type.
2014-01-26 13:43:04 +01:00
Pawel Dziepak
d0f2d8282f Merge branch 'scheduler'
Conflicts:
	build/jam/packages/Haiku
	headers/os/kernel/OS.h
	headers/os/opengl/GLRenderer.h
	headers/private/shared/cpu_type.h
	src/add-ons/kernel/drivers/power/acpi_battery/acpi_battery.h
	src/bin/sysinfo.cpp
	src/bin/top.c
	src/system/kernel/arch/x86/arch_system_info.cpp
	src/system/kernel/port.cpp
2014-01-17 04:06:15 +01:00
Adrien Destugues
2d0e1ed2f3 be_locale_roster is gone.
Reference the proper method to get the global locale roster object.
2013-12-24 09:28:42 +01:00
autonielx
037cd3a1a9 Update userguide from i18n.haiku-os.org 2013-12-15 13:04:28 +01:00
John Scipione
46f5821ad1 Add docs for BOutlineListView class 2013-12-11 16:15:15 -05:00
John Scipione
853f724631 Minor updates to BListView docs 2013-12-11 16:13:12 -05:00
Ingo Weinhold
556e8b250a Update BPathFinder API docs
* Update FindPath() wrt. B_FIND_PATH_PACKAGE_PATH handling.
* Add documentation for BResolvableExpression version of constructor and
  SetTo().
2013-11-21 13:29:21 +01:00
Ingo Weinhold
7afd687f61 Add BPathFinder API docs 2013-11-19 02:05:37 +01:00
Ingo Weinhold
418c3fce24 Add get_*architecture*() API docs 2013-11-19 02:05:36 +01:00
Ingo Weinhold
8cb65bf1d7 Add find_path*() API docs, improve FindDirectory.h docs 2013-11-19 02:05:36 +01:00
John Scipione
7192a9313e Add documenation for BPopUpMenu class 2013-11-11 19:28:04 -05:00
John Scipione
24be9ac7fd Update SetRadioMode() method to descibe radio mode 2013-11-11 19:27:13 -05:00
John Scipione
0096a29e9c Add BMenuField class documentation 2013-11-08 19:29:13 -05:00
John Scipione
d7d2ff5bde Minor updates to the BMenu and BMenuBar classes.
Remove the reimplemented hook methods groups because some
hook methods are there, some are not, unfortunately doxygen can’t
tell if a hook method just calls the default or does something else and
we tend to include all the hook methods even if we don’t actually make
any functional changes to them making the docs a bit more verbose
than they otherwise would be.
2013-11-08 19:29:13 -05:00
John Scipione
a676c40c3e Some minor updates to BControl docs. 2013-11-08 19:29:12 -05:00
John Scipione
8b4655091d More minor updates to the BView docs. 2013-11-08 19:29:12 -05:00
waddlesplash
72dfdc7940 Set INLINE_INHERITED_MEMB to NO.
* "YES" causes all members of a class to be stuck in that class' page.
* No need to do that, there's a "List all members" page.
* This will make the docs a lot smaller and easier to read.

Signed-off-by: John Scipione <jscipione@gmail.com>
2013-11-07 17:18:54 -05:00
John Scipione
34ce2cefc8 BMenuBar docs, silly mistake 2013-11-06 19:35:01 -05:00
John Scipione
ed7c19b5ef Added BMenuBar docs. 2013-11-06 19:26:34 -05:00
John Scipione
0d635255f5 Minor updates to BMenu docs.
Added an Archive() method description.
2013-11-06 19:23:48 -05:00
John Scipione
45e17d3d42 Update BView::DrawAfterChildren() param name
... from r to updateRect, no functional change intended.

Also a tiny change to the param description in the docs.
2013-11-06 13:14:53 -05:00
John Scipione
2f746eafdc Add BMenu documentation 2013-11-06 12:21:58 -05:00
John Scipione
45b87db2b7 A few minor updates to the BView docs 2013-11-06 12:21:57 -05:00
Pawel Dziepak
d929eb20ba docs: Update atomic_*() functions documentation 2013-11-05 22:54:25 +01:00
John Scipione
d0350bc385 Comment out B_COMMON_ constants for now 2013-11-05 13:40:22 -05:00
John Scipione
dd1281c99b Style fixes to FindDirectory 2013-11-05 13:36:23 -05:00
John Scipione
f27f868283 Not in group libbe 2013-11-05 13:25:00 -05:00
John Scipione
40cbf3eb0e Documentation fixes to HttpRequest, fixes warnings. 2013-11-04 20:17:45 -05:00
John Scipione
f8133e6de7 Documentation updates to HttpForm
Stub out missing method docs.
2013-11-04 20:17:18 -05:00
John Scipione
31005da9b8 Update BWindow shortcut docs 2013-10-20 15:51:34 -04:00
François Revol
3940abc9b8 ARM: add a TODO for KDL disasm module
Possible source is NetBSD, thanks pulko for mentionning.
2013-10-19 15:55:18 +02:00
Adrien Destugues
25b034e99c HttpRequest: docs and memory management fixes
* Now takes ownership of headers, form data and input data
 * Split Set* and Adopt* methods to help with proper use of this (Set
does a copy)
 * Write documentation.
2013-10-17 14:24:20 +02:00
Adrien Destugues
7ed015e409 Integrate comments from Axel over the ML. 2013-10-05 10:09:44 +02:00
Adrien Destugues
4cf6217227 Document some classes for the Network Kit. 2013-10-04 16:57:00 +02:00
Adrien Destugues
6ec9625a36 Fix mismatched prototypes in the Haiku Book. 2013-10-04 16:56:59 +02:00