Commit Graph

94 Commits

Author SHA1 Message Date
Niels Sascha Reedijk
49aa230740 Style, spelling and grammar changes. Courtesy of Tim Howe
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33562 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-12 21:09:12 +00:00
Ingo Weinhold
9ab8968af3 Added sections on checking access permissions, node monitoring, and caches.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29797 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-30 02:22:27 +00:00
Ingo Weinhold
0551e706bf * Updated to current FS interface.
* Fixed and completed several function documentations. There's still quite
  a bit missing.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29787 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-29 17:17:55 +00:00
Ingo Weinhold
d117d093a2 Updated the FS introduction. It's in sync with the current API again, but some
new sections for caches and FS layers should be added.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29768 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-28 21:50:19 +00:00
Ingo Weinhold
50c9917f8f Resurrected the FS interface documentation and introduction. It's not in sync
with the current API, but it just needs to be updated rather than rewritten
from the scratch.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29766 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-28 21:00:53 +00:00
Niels Sascha Reedijk
dae3adab03 Rewording by Tim Howe with some suggestions by Bob Colwell. Thanks guys.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29262 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-20 10:20:54 +00:00
Niels Sascha Reedijk
25630ec983 Removing the file system interface documentation for now. This needs to be replaced with a completely new version that accounts for all the new features (including the overlay modules)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29243 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-18 11:04:27 +00:00
Niels Sascha Reedijk
702a1e7241 Tweak looks of API documentation.
WIP:
 * Only a first subset of CSS has been applied
 * Look based on Humdinger's and other's work on user guide
 * Navigation is still ugly. I need to work around the limitations of Doxygen. Maybe by a patch though.
 * Needs a manual extra step: you need to copy the /trunk/docs/userguide/images/logo.png to the /trunk/generated/doxygen/html directory

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29117 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-01 21:44:07 +00:00
Ingo Weinhold
67e2e88213 Added a section to the select() hook documentation discussing the FSs
responsibility never to call notify_select_event() after deselect().


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25262 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-04-29 21:52:30 +00:00
Niels Sascha Reedijk
ce9ba9b376 First version of the BMessageQueue documentation.
Note: I have cleared the original MessageQueue.cpp file from the inline documentation. When the storage kit comes up, we need to rediscuss the documentation policy.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24522 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-22 14:36:20 +00:00
Ingo Weinhold
1b32947d3f * Aligned the semantics of the read_symlink() FS module hook with the
readlink() function. It is no longer required to null-terminate the
  string, shall not fail, if the buffer is too small, and shall return
  the length of the string actually written into the buffer.
* Adjusted rootfs, devfs, and bfs accordingly. Also adjusted their
  read_stat() hooks to return the correct symlink length in st_size.
* Our readlink() does now comply to the standard (and BeOS).
  Additionally if the buffer is big enough it is nice to non-conforming
  apps and null-terminates it.
* BSymLink::ReadLink() explicitly null-terminates the string now.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24425 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-17 21:37:40 +00:00
Niels Sascha Reedijk
0f3d1b86b0 Correct some mistakes pointed out by Stephan
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24338 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-09 20:39:57 +00:00
Niels Sascha Reedijk
da3abc7c16 Handler.dox:
- Small link fix
- Clean up the titles of the subsections a bit: these are reused in the looper documentation and they sort of clashed before.

Also, new documentation for Looper.dox!

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24304 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-08 15:11:39 +00:00
Niels Sascha Reedijk
a7f59ef8eb Fix the description for StartWatching() after a hint from Axel. There are two different behaviours for both overloaded variants. (which is bad, IMO)
*waves at Axel*

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23443 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-01-12 16:57:50 +00:00
Niels Sascha Reedijk
6fd8b07afc Add a note about using messages for data storage. Thanks to mlotz for telling me this functionality was underexposed in the current docs.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23170 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:30:30 +00:00
Niels Sascha Reedijk
3f56983aa8 Small typo
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23169 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:19:45 +00:00
Niels Sascha Reedijk
301744b8ac Phase I of the BHandler documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23168 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:17:20 +00:00
Niels Sascha Reedijk
4f6e481644 Some improvements suggested by Axel. Thanks.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22576 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-15 19:56:05 +00:00
Niels Sascha Reedijk
dcdb996481 Phase I of the Message.dox file
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22564 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-15 11:49:54 +00:00
Niels Sascha Reedijk
445e975fda Correct typo. Fix bug #1548
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22543 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-13 22:13:42 +00:00
Niels Sascha Reedijk
51e5c73eca Phase I of MessageFilter.dox
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22350 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-28 21:14:39 +00:00
Niels Sascha Reedijk
b15c8e82c2 Minor fixes. Finishes the first version.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22264 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-19 22:22:41 +00:00
Niels Sascha Reedijk
575d819a54 First part of the messaging overview
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22240 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-17 21:33:24 +00:00
Niels Sascha Reedijk
8a44618225 Create framework for Application Kit.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-08 10:29:30 +00:00
Niels Sascha Reedijk
99b3aeed2d git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-08-06 14:28:40 +00:00
Niels Sascha Reedijk
55f7db1bd9 Update according to the latest guideline changes. These files already
passed phase 3, so they wouldn't be updated during the regular process. 
I guess the other files will get that update.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21833 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 09:32:27 +00:00
Niels Sascha Reedijk
ff3d9bfa2a Update the API guidelines to make them more consistent with the coding
guidelines. Three new guidelines:
- Commas between names and email adresses in header blocks.
- Indent with tabs (with lenght 4)
- Two whitelines between blocks


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21832 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 09:09:29 +00:00
Niels Sascha Reedijk
40ba6c7004 Fix a mistake. \code should always be closed by \endcode, else doxygen will stop parsing (even if a documentation block ends).
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21694 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-23 22:41:58 +00:00
Axel Dörfler
ca210f74f1 * Spaces to tabs.
* Carriage returns to simple new lines.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21627 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-16 21:47:13 +00:00
Axel Dörfler
5d92d947c2 * Completed some more missing parts.
* Replaced some more spaces with tabs, though still not complete.
* And I forgot: the last commit also removed some garbage at the beginning of the file.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21617 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-15 18:09:43 +00:00
Axel Dörfler
84f03dd594 * Removed deprecated functions.
* The documented the notify_*() functions - only notify_listener() was deprecated
  among them.
* Replaced spaces with tabs - there is no reason to deviate from the standard we're
  using everywhere else.
* Completed the docs here and there.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21615 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-15 13:31:02 +00:00
Niels Sascha Reedijk
412a49defe Update to the latest prototypes of fs_interface.h
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21584 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-07 08:29:52 +00:00
Niels Sascha Reedijk
b653632762 Wrote as much documentation as I could understand. There are quite a few gaps left (search for TODO). I hope people (Ingo, Axel?) with more knowledge on this subject can check the written docs, make suggestions for improvement, and fill the gaps. After that, it needs a good revision to make the whole more consistent.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21483 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-21 16:29:43 +00:00
Niels Sascha Reedijk
cb15abc767 Update to Doxygen 1.5.2.
Please update your executable if you are generating the documentation.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21404 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-13 12:53:48 +00:00
Niels Sascha Reedijk
e3c5ca8539 Patch by Thom Holwerda. Proofreading.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21318 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-04 06:37:04 +00:00
Niels Sascha Reedijk
37503f54ec Technical proofreading by David Weizades.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21264 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-29 15:24:25 +00:00
Niels Sascha Reedijk
dc84754eef Patch by Thom Holwerda:
"Phase III .diff for BlockCache.dox.

Not much to change here, some really minor things only. The thing
that makes the .diff large is the fact that many lines were more like
70char than 80char."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21258 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 12:18:49 +00:00
Niels Sascha Reedijk
8ace9affed Work in progress. I'm still working on documenting many of the fs hooks, but I just wanted to commit this to quiet down the amount of warnings that are produced.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21257 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 08:18:43 +00:00
Niels Sascha Reedijk
c24f6c7e26 Add some more credits. I hope I got everyone now.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21256 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 08:11:24 +00:00
Niels Sascha Reedijk
5dee3b1245 Initial version of the TLS documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21226 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-24 11:13:20 +00:00
Niels Sascha Reedijk
8b44d0db76 Patch by Thom Holwerda.
Proofreading.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21219 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 13:25:33 +00:00
Niels Sascha Reedijk
1e36cfc272 Move the 'mail' documentation out of the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21218 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 10:03:30 +00:00
Niels Sascha Reedijk
bef614ef09 Add Credits to the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21217 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 09:25:00 +00:00
Niels Sascha Reedijk
bdad0425c4 Patch by David Weizades
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21208 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-22 16:50:08 +00:00
Niels Sascha Reedijk
02d0a2eab1 Patch by David Weizades (thanks!):
"Fixed the indentation and went over the cross references. Everything appears
to be in order and should be ready for committal. It adheres to the coding
guidelines and should be good to go."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21206 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-22 13:58:43 +00:00
Niels Sascha Reedijk
de41d9ee27 Update the guidelines acording to the decisions during the meeting
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21188 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-21 15:45:39 +00:00
Niels Sascha Reedijk
0d975479fb First iteration of the documentation that describes how to write drivers that use the USB module.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21162 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-17 16:08:33 +00:00
Niels Sascha Reedijk
5625684593 Patch by Alan Smale:
"I have made the doc header consistent with what the document content
specifies it should be.

I've rephrased things and corrected typos and spelling.

Checked through the grammar and amended some gramatical errors."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21103 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-10 09:02:45 +00:00
Niels Sascha Reedijk
b821eb28c8 git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20838 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-04-26 11:13:29 +00:00
Niels Sascha Reedijk
81071f5e8a Large documentation update:
- Add the beginnings of the documentation for the USB module
- Fix some mistakes here and there
- Almost finished the support kit. Tried to update everything to the standards

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20724 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-16 09:28:29 +00:00