Commit Graph

625 Commits

Author SHA1 Message Date
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
François Revol
b8ded2f897 Merge branch 'master' into sam460ex 2013-05-27 17:45:55 +02:00
Alexander von Gluck IV
0d24800212 docs: Add initial BeagleBone Black docs
* No porting has occured, just collecting
  information as it is a likely target
* #9716
2013-04-28 13:02:03 -05:00
Alexander von Gluck IV
107ab75ea6 docs: Clean up RaspberryPi Documentation; move
* Convert the RaspberryPi documentation to markdown
* Move into the proper arm port docs location
2013-04-28 12:37:36 -05: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
François Revol
eecde8e37c Merge branch 'master' into sam460ex 2013-04-21 01:34:20 +02:00
Ingo Weinhold
a37c845e52 FS interface API doc: More details for unmount() 2013-04-04 12:00:08 +02:00
François Revol
d4eea7d43c Merge branch 'master' into sam460ex 2013-03-28 09:47:50 +01: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
François Revol
f106fe34d2 Merge branch 'master' into sam460ex 2013-03-09 03:50:12 +01: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
François Revol
00661368a2 PPC: Document how to automate TFTP-boot Haiku on Sam460ex
* U-Boot seems to have a very small limit on serial or shell input buffer,
so we split the commands into several variables that we run in sequence.
2013-02-23 04:01:19 +01: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
François Revol
c3052f0795 Merge branch 'master' into sam460ex 2013-02-22 16:58:43 +01: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
Niels Sascha Reedijk
a6b0b081cc Update userguide translations 2013-02-17 21:56:39 +01:00
François Revol
cb77e62c17 Merge branch 'master' into sam460ex 2013-02-16 22:58:27 +01: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
François Revol
8d96ebeb59 Merge branch 'master' into sam460ex 2013-02-12 19:48:05 +01: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
François Revol
88fe1cd3a5 Merge branch 'master' into sam460ex 2013-02-09 16:25:21 +01: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
François Revol
5d9c157d6e Merge branch 'master' into sam460ex 2013-02-08 01:38:37 +01: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
John Scipione
41611c9c5e Assign class docs for app and support to libbe group, not libroot 2013-02-07 15:04:05 -05:00
John Scipione
30b280b217 Style the interface diagram title as an h2 2013-02-07 14:49:43 -05:00
John Scipione
027cfe666e Bound the interface diagram.
The interface diagram for BArchivable has become too wide to fit on
the page so I've put the diagram in a box and made it scrollable.
While I'm at it give the interface diagram a silver border and
center it on the page.
2013-02-07 14:42:20 -05:00
John Scipione
db5b891db2 Move app and support class docs from libbe to libroot.
Also a few more style and spelling fixes.
2013-02-07 14:19:09 -05:00
John Scipione
6dc7e05ecf Update BBuffer class docs. 2013-02-07 02:11:09 -05:00
John Scipione
820dca4df6 Big docs cleanup.
* Fixed headers including:
  - All rights reserved not All Rights Reserved.
  - name, email@domain.com not name <email@domain.com>
  - tabs and spaces
  - Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.
2013-02-07 02:01:19 -05:00
François Revol
34a12c7678 Merge branch 'master' into sam460ex 2013-02-03 00:39:40 +01:00
John Scipione
b7733e0655 Move Mime.h documentation to the API docs. 2013-01-31 20:47:06 -05:00
John Scipione
ec96e7af1a Fix warning in FilePanel.dox 2013-01-30 19:51:01 -05:00
John Scipione
400a2a1813 Fix warning in DurationFormat.dox 2013-01-30 19:50:41 -05:00
John Scipione
8bbea122eb Use the version from the cpp file, not the header for \fn 2013-01-30 19:38:55 -05:00
John Scipione
bf20349b34 Correct a few more param instances in BHandler docs 2013-01-30 19:35:50 -05:00
John Scipione
ce5b408f1f A few doc fixes to BApplication and BHandler.
* Since <em> is used for parameters we can't use it for emphasis.
* Add \a in a few places it was missing to indicate a parameter.
* Change \a to a \c in one instance, param -> constant.
* Lots of whitespace fixes, most just deleting leading tabs.
* Don't indent code blocks, they should be flush to left since any
  indentation is preserved in the output.
2013-01-30 19:18:30 -05:00
John Scipione
a3c5efd2e9 Color parameters in parameter lists grenadier (orange) as well. 2013-01-30 18:58:55 -05:00
John Scipione
c896b0c34c Color parameters grenadier (orange) in API docs. 2013-01-30 18:54:16 -05:00
John Scipione
8bbff5c9ed Update dd style in API docs.
Only make the font size 12px for the special note, warning, etc. blocks
not all dd blocks.
2013-01-30 18:43:09 -05:00
Alexander von Gluck IV
9a5c1309d7 doc: Add some OpenGL kit documentation
* Reduce bus factor.. this stuff is complex.
  ( I blame the developer who wrote it :\ )
2013-01-27 16:46:09 -06:00
John Scipione
90ae2e54f6 Update keycodes image with more stylish version 2013-01-21 20:10:59 -05:00
François Revol
287040333d Merge branch 'master' into sam460ex 2013-01-20 23:57:00 +01:00
John Scipione
3528f5bb69 Add BBitmapStream docs and translation kit stub 2013-01-19 15:05:11 -05:00
John Scipione
6a4b222bc9 Use condensed, not squished together. Better 2013-01-19 13:17:50 -05:00
John Scipione
4f7717a999 By removing the style on escapement_delta doxygen links it up which is better 2013-01-19 13:17:49 -05:00
John Scipione
27c3eae9b4 Another minor fix, style constant 2013-01-19 13:17:49 -05:00
John Scipione
0d2b04ca83 Minor update use fixed font for B_OK 2013-01-19 13:17:49 -05:00
John Scipione
05757eb6b3 Fill out BFont detailed description.
Also a bunch of cleanup including removing private method docs
and cleaning up language. BFont is pretty much completely documented
at this point.
2013-01-19 13:17:48 -05:00
John Scipione
c258d2fa0e Fill out BFont member docs 2013-01-19 13:17:47 -05:00
John Scipione
566e828c5f Add initial BFont documentation 2013-01-19 13:17:46 -05:00
John Scipione
c45e8003d3 Update font size of memberdoc tables from 13px to 14.4px 2013-01-17 18:13:05 -05:00
John Scipione
4aae53f373 Update Haiku Book CSS
* Update headers to match User Guide better for font and spacing.
* 14.4px is the default font size (matching user guide).
* because we use em's for page width this makes the text area a bit narrower.
* Make note, warning, stop, remark notifications font size smaller to make
  them stand out a bit less and better matches the User Guide.
2013-01-16 12:44:22 -05:00
John Scipione
5e6540723d Update BFilePanel docs, especially detailed description and constructor 2013-01-15 23:07:12 -05:00
François Revol
7daaf25d9c Merge branch 'master' into sam460ex 2013-01-15 07:09:10 +01:00
John Scipione
2b934bb6ae Add BFilePanel and BRefFilter documentation 2013-01-14 23:31:18 -05:00
John Scipione
ea468b9855 Add \brief tag so description appears in files table 2013-01-14 21:11:15 -05:00
John Scipione
0abbcaaa35 Update Doxyfile to 1.7.5.1 2013-01-14 20:33:50 -05:00
François Revol
0ccce7886f Merge branch 'master' into sam460ex 2012-12-27 15:50:06 +01:00
John Scipione
93ebe7637f Update BDurationFormat docs. Came for warnings, ended up fixing more. 2012-12-24 19:55:26 -05:00
John Scipione
89dfe27fc8 Update BCatalog docs to fix warnings and update.
Especially listing the status codes is useful. Some style fixes and
update \li to -.
2012-12-24 19:07:56 -05:00
John Scipione
495275e4ea Add BFileInterface class documentation 2012-12-24 18:36:55 -05:00
John Scipione
c8654dba73 Minor updates to BFileGameSound docs 2012-12-24 18:31:08 -05:00
John Scipione
939600d2ad Update SetPaused() and add IsPaused() documentation 2012-12-24 16:05:51 -05:00
John Scipione
05c71c9699 Add BFileGameSound class documentation 2012-12-24 15:42:48 -05:00
François Revol
be95f65a23 Merge branch 'master' into sam460ex 2012-12-24 01:52:39 +01:00