Commit Graph

357 Commits

Author SHA1 Message Date
John Scipione
274571d8a9 BCheckBox doc updates.
Many missing methods added.
2014-05-28 14:09:56 -04:00
John Scipione
78615023ce BControl docs update. 2014-05-28 14:05:45 -04:00
John Scipione
9c244999df Update BView docs, especially MouseMoved() 2014-05-28 12:14:43 -04:00
John Scipione
8c2c52ff67 BView docs: move description up, few updates. 2014-05-28 12:14:09 -04:00
John Scipione
cbb1537fa2 Add documentation for BPolygon class. 2014-05-21 16:15:13 -04:00
John Scipione
30275c3f99 Add BPoint documentation. 2014-05-20 16:01:37 -04:00
John Scipione
18d4375e7c Fill out documentation for BPictureButton class. 2014-05-19 20:13:39 -04:00
John Scipione
03608f354a Fill out documentation for BPicture class. 2014-05-19 20:13:38 -04: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
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
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
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
Niels Sascha Reedijk
0e1ec24ac0 Merge all the documentation from Archivable.h together 2013-09-29 11:48:33 +02:00
Niels Sascha Reedijk
b7235efc80 Update support kit documentation to the latest changes on trunk
SetSubDirSupportedPlatformsBeOSCompatible ;
2013-09-29 11:48:33 +02:00
John Scipione
e9eb899aa4 BFont docs: Update SetEncoding() with some new info 2013-08-25 21:36:50 -04:00
Ingo Weinhold
5163e1c62d Revert "Introduce vnode op supports_operation(), fix devfs_io()"
This reverts commit 98a5231fe5.
2013-07-27 23:31:23 +02:00
Ingo Weinhold
98a5231fe5 Introduce vnode op supports_operation(), fix devfs_io()
devfs_io() can't fall back to calling vfs_synchronous_io(), if the
device driver doesn't support handling requests asynchronously. The
presence of the io() hook leads the VFS (do_iterative_fd_io()) to
believe that asynchronous handling is supported and set a
finished-callback on the request which calls the io() hook to start the
next chunk. Thus, instead of iterating through the request in a loop
the iteration happens recursively. For sufficiently fragmented requests
the stack may overflow (ticket #9900).

* Introduce a new vnode operation supports_operation(). It can be called
  by the VFS to determine whether a present hook is actually currently
  supported for a given vnode.
* devfs: implement the new hook and remove the fallback handling in
  devfs_io().
* vfs_request_io.cpp: use the new hook to determine whether the io()
  hook is really supported.
2013-07-27 17:45:59 +02:00
John Scipione
f59d62ffd3 Add BWindow documentation 2013-07-26 18:36:17 -04:00
John Scipione
080bf8fe19 Fix rest of warnings, doxygen now runs cleanly.
The BTextView::SetText() methods were included twice, update the first and
remove the second.
2013-07-08 19:30:45 -04:00
John Scipione
e724b26f23 Remove enum elaborated type specifier
...from orientation params. Elaborated type specifiers are not needed
for C++ code and removing them makes doxygen happy. Verified working
on both gcc2h and gcc4h builds.
2013-07-08 19:29:11 -04:00
John Scipione
27929dcd1d BView docs: Add remaining new method descriptions
Layout and Tool Tip method documentation.

Also ScrollWithMouseWheelDelta()
2013-06-28 23:18:55 -04:00
John Scipione
468559e46d Update BView docs for changes in hrev45799 2013-06-28 23:12:38 -04:00
John Scipione
dd84193fa4 Begin filling out the detailed description 2013-06-28 20:28:45 -04:00
John Scipione
1126023668 Fill out the constructor docs. 2013-06-28 20:28:43 -04:00
John Scipione
2891821fde Fill out the BView docs
* Fill out the Input related method descriptions and also some other updates
  to method and variable descriptions.
* Document Graphics State Methods and a bunch of Drawing Related Methods
* Add a bunch more drawing method descriptions.
* Fill out the rest of the methods of the BView class.
2013-06-28 20:28:32 -04:00
John Scipione
8fc951cebb BFont docs: Clarify escapement_delta language.
Make it clear that the values provided by the escapement_delta struct are an
input to App Server which allows the user to specify extra horizontal space around each character and is not an output provided by App Server.
2013-06-13 14:35:03 -04:00
John Scipione
4cbcabff5f Add documentation for BListView and BListItem classes 2013-04-25 17:58:13 -04:00
John Scipione
2d5697e109 A few fixes to TextView.dox, \see BView::method() 2013-04-25 17:57:35 -04:00
Ingo Weinhold
a37c845e52 FS interface API doc: More details for unmount() 2013-04-04 12:00:08 +02:00
Axel Dörfler
40440e7419 Clarified why the documentation does not belong into headers.
* Haiku is slow, and that's why we do not put documentation in headers???
  Hell yeah.
2013-03-22 20:56:17 +01:00
John Scipione
6e8749b27f Update BMessage documentation adding Get* methods.
Also, lots of little cleanups: formatting, adding return statements and
return values where they were missing, fix spelling mistakes, add newlines to
separate command blocks, remove trailing whitespace.
2013-03-18 20:05:45 -04:00
John Scipione
d58ff0b187 Add BTextView class docs 2013-03-16 17:22:56 -04:00
John Scipione
ca9a59bbc5 add a newline 2013-03-16 17:04:44 -04:00
John Scipione
880e147bd9 Node Monitor documentation updates to stop_watching().
* Add a note to stop_watching() about the asynchronous nature of node
  monitoring and its consequences.
* Also update the breif description and parameters of stop_watching().
* Detail the return values of stop_watching() a bit better.
* Add a note (an \attention actually) to B_STOP_WATCHING flag.
* Fix a spelling mistake and other minor fixes.
2013-03-04 19:24:31 -05:00
John Scipione
5dd0761042 Move BVolumeRoster docs to Haiku Book.
With this commit every class in the storage kit is now documented
in the Haiku book!

Thanks to Ingo, Axel, Vincent Dominguez, Tyler Dauwalder, and
everyone who helped document these classes.
2013-02-22 18:11:14 -05:00
John Scipione
bcd9244e4a Fix BCountry::GetName() method that was showing in BVolume::GetName() 2013-02-21 20:16:34 -05:00
John Scipione
9d5f5318a5 Move BVolume docs to the Haiku book 2013-02-21 20:15:53 -05:00
John Scipione
7635a303a2 SymLink.h not Symlink.h 2013-02-21 20:14:58 -05:00
John Scipione
52266c1de7 Minor correction, BDirectWindow not DirectWindow. 2013-02-20 16:38:56 -05:00
John Scipione
434716ced8 Add BSymLink class docs to Haiku Book 2013-02-20 16:20:53 -05:00
John Scipione
29f51b3431 Set brief for desc of Path.h Query.h Resources.h and Statable.h 2013-02-19 19:25:04 -05:00
John Scipione
5bff846db2 Move BStatable docs to Haiku Book. 2013-02-19 19:07:15 -05:00
John Scipione
8e13dec040 Correction in the BStopWatch contructor docs 2013-02-18 19:47:25 -05:00
John Scipione
db616065fa Update BStopWatch documentation 2013-02-18 19:39:34 -05:00
John Scipione
6d5fae2a5a Move resources docs to Haiku Book
* Remove docs from Resources.cpp (leaving the brief description).
* Reformat Resources.h to style it like so many other header files.
* There is one not-entirely style based change. I renamed the outSize
  parameter or the LoadResource method to _size as is our convention for out
  parameters.
2013-02-18 18:14:10 -05:00
John Scipione
0a9ac70aea Move BQuery docs into Haiku Book.
... removing the docs from the .cpp and .h files and cleaning up as usual.
2013-02-14 19:36:33 -05:00
John Scipione
6d287908b1 Fix warning and cleanup for BPath docs 2013-02-14 19:35:48 -05:00
John Scipione
855a423a5e Forgot this, add a period 2013-02-10 16:13:03 -05:00
John Scipione
61feea6280 Minor BPath doc cleanups.
* Implements BFlattenable::method not overrides, pure virtual.
* Tense of return values should be past.
2013-02-10 16:10:25 -05:00
John Scipione
4c064a8451 Move documentation from Path.cpp to Path.dox
And clean it up a bit. Kept brief description in source.
* Also added Axel to authors in Path.dox and Path.cpp because his name
  appears in git blame as working on the docs and code for the file.
  I hope he doesn't mind.
2013-02-09 00:39:53 -05:00
John Scipione
b3252dc18a NodeMonitor doc updates 2013-02-08 22:43:36 -05:00
John Scipione
185c12a1b7 Whoops, NodeInfo.h not Node.h 2013-02-08 22:42:54 -05:00
John Scipione
5367161777 Some updates to NodeInfo docs 2013-02-08 22:14:09 -05:00
John Scipione
fc9827011d Moved NodeMonitor docs to Haiku Book. 2013-02-08 20:39:35 -05:00
John Scipione
66d07bdfce Copy-pasta error: storage not app 2013-02-07 23:22:22 -05:00
John Scipione
81c42a7685 Move documentation from NodeInfo into the API docs.
* Delete the docs from NodeInfo.cpp and NodeInfo.h
* I snuck a couple of style fixes into NodeInfo.cpp
* I had to make a small modification to MimeType.dox to prevent it
  from overriding the docs of one of the methods in NodeInfo.dox.
2013-02-07 23:17:01 -05:00
John Scipione
131261d2b5 Remove remaining /trunk/ before file references. 2013-02-07 21:19:06 -05:00
John Scipione
51fe39ae0f Renamed stopwatch.dox to StopWatch.dox 2013-02-07 16:04:04 -05:00
John Scipione
faeb2ff331 Move syslog.dox from support to posix and put it in libroot.so 2013-02-07 15:52:25 -05:00
John Scipione
a93a16151d Fix doxygen warnings, enums can only be in 1 group 2013-02-07 15:52:07 -05:00