Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
58,757 Commits 9 Branches 0 Tags 473 MiB
8aea77d00f
Commit Graph

477 Commits

Author SHA1 Message Date
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
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
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
John Scipione
90ae2e54f6 Update keycodes image with more stylish version 2013-01-21 20:10:59 -05: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
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
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
John Scipione
e1988c7d53 Reduce font size of code blocks to 13px 2012-12-23 12:05:03 -05:00
John Scipione
e9191cc2d1 Add BFile documentation to the Haiku Book. 
Remove the documentation from the cpp file also. Keep the brief
description as a regular comment though.
 2012-12-22 15:01:17 -05:00
John Scipione
8e7094494a Fix another warning in MimeType.dox along with some 80 char fixes 2012-12-22 15:01:17 -05:00
John Scipione
268177055e Fix 2 warnings in MimeType.dox 2012-12-21 22:51:19 -05:00
John Scipione
f729cb8d48 Remove methods from CheckBox.dox that are not unique to the class fixing warnings 2012-12-21 22:51:19 -05:00
John Scipione
177942adc7 Remove documentation fro Button.dox that is not unique to BButton fixing a few warnings 2012-12-21 22:51:18 -05:00
John Scipione
e5f2a41917 Update revision, this matters because I changed the variables in the BDragger constructor. 2012-12-21 22:34:27 -05:00
John Scipione
a6ada82b00 Add BDragger class documentation 2012-12-21 22:31:29 -05:00
John Scipione
ceaf7141fa BDirectWindow class documentation fixes 2012-12-21 21:01:40 -05:00
John Scipione
b1b809ef27 Add preliminary DirectWindow documentation 2012-12-21 20:38:18 -05:00
John Scipione
746abcb938 Add BCursor class documentation 2012-12-21 18:26:29 -05:00
Niels Sascha Reedijk
4b140bad0d Update the BString documentation. 
* Remove the reference to BString::fPrivateData, as it currently really
   is marked as private and as such disappeared from the docs.
 * Add the various character methods that have been added in the
   previous revisions.
 2012-05-12 11:54:07 +02:00
Oliver Tappe
546208a539 More catalog-related cleanup. 
* rename B_TRANSLATE_CONTEXT to B_TRANSLATION_CONTEXT and
  B_TRANSLATE_WITH_CONTEXT to B_TRANSLATE_CONTEXT, squashing a TODO
* adjust all uses of both macros in Haiku's source tree
* use correct header guard for collecting/Catalog.h

The renamed macros require adjustments to all external applications
using catalogs.
 2012-04-16 21:31:22 +02:00
John Scipione
12c10314f9 Remove MimeType docs from MimeType.cpp and cleanup style issues in that file. Create a MimeType.dox file and add the docs there. 2012-03-18 00:09:53 -04:00
John Scipione
f969ed4153 A few formatting tweaks in the BEntry and BDirectory class documentation. 2011-12-18 21:43:22 -05:00
John Scipione
d4fa97f8f8 Moved documentation for the BEntry class into a dox file to include it into the Haiku book. 2011-12-18 21:28:55 -05:00
John Scipione
a92e17b124 Fix copyright line to Haiku, Inc. in Directory.dox and a few more small fixes. 2011-12-18 21:26:02 -05:00
John Scipione
38f6a824d2 Fix copyright line to Haiku, Inc. in GameProducer.dox 2011-12-18 21:25:31 -05:00
John Scipione
8786818cf2 Add documentation for the GameProducer class in the Game Kit. 
This documentation was provided by Omri Barak, a student participating
in Google Code Initiative (GCI) 2011.

Signed off by John Scipione

Since this is the first class documented in the Game Kit I also added
a reference to the Game Kit to the API docs front page.
 2011-12-18 19:42:33 -05:00
John Scipione
2ac1eb67b3 Move the doxygen documentation comments from src/kits/storage/Directory.cpp to docs/user/storage/Directory.dox and update it both the language, fix a few errors, and bring the syntax up to snuff. The documentation for the BDirectory class is now added to the Haiku Book. 2011-12-18 18:53:46 -05:00
Alex Wilson
a84e14ca84 Merge branch 'master' of git://github.com/haiku/haiku 2011-12-15 20:50:28 -07:00
Alexander von Gluck IV
157046ce4b Fix spelling mistake in user doc 2011-12-12 13:47:05 -06:00
Alex Wilson
8f0b7c3fb8 Update doxygen docs for Layout, LayoutItem on invalidation. 2011-12-06 23:39:16 -07:00
John Scipione
2231cbd5fe Replace the US_PC_keyboard_keycodes.png image in the Keyboard special topic of the Haiku book with an optomized version saving over 100k. 2011-11-18 15:59:41 -05:00
Adrien Destugues
5caae4d450 Fix documentation of Collator: Greater and GreaterOrEqual are not commutative (that would mean Greater(s1, s2) is the same as 
Greater(s2, s1), and adding a negation in front of them is not enough either.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43233 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-11 09:19:19 +00:00
John Scipione
f69cadd0e9 Update the BCollator class documentation to fix a number of spelling errors and make the text clearer and easier to read. Also add a bunch of details, a few warnings and notes and other small typographical changes. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43232 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-11 03:55:09 +00:00
John Scipione
a2547dba0e A few updates and corrections to the new Keyboard page in the Haiku Book. I hope I got this in time before the next scheduled build of the Haiku Book. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43231 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-11 02:38:48 +00:00
John Scipione
4466b89c65 Add a section to the Haiku Book with a very special topic, the keyboard. 
This started off as just being a page to detail the key codes since I find
myself constantly referencing the BeBook page on the subject and it is
horribly broken. However, the page has grown to detail many of the keyboard
related methods and constants defined in InterfaceDefs.h as well. A very
long and detailed explanation of the key_map structure is included.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-10 08:35:38 +00:00
John Scipione
38a0577422 Set SORT_MEMBERS_CTORS_1ST variable to YES in the Doxyfile so that constructor and destructor methods will get sorted before member methods in class documentation files. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43099 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-02 09:17:38 +00:00
John Scipione
90a55c448a Copy paste mistype, B_WEEKDAY_FRIDAY instead of B_WEEKDAY_THURSDAY twice. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43097 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-02 08:40:28 +00:00
John Scipione
6ac7032dc6 Update the style of the Haiku Book to resemble the User Guide. 
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-02 08:36:02 +00:00
John Scipione
740ae7fef6 Return B_ERROR if a locking error occurs in while locking the BLocale object, return B_BAD_VALUE if an ICU error occurs or the passed in value is NULL. Update BLocale API documentation to reflect this and also add some more documentation fixes. Closes #7901 pending confirmation. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43095 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-11-02 06:02:36 +00:00
Niels Sascha Reedijk
7f1880dc0e Apply patch for ticket #8008: 
* Remove BNode documentation from the source code and add it to Node.dox
 * Rewrite some of the existing documents


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42986 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-10-29 22:02:52 +00:00
Niels Sascha Reedijk
1326b9d0b4 Apply the patch by jscipione on ticket #7994. 
* Update BScreen class style and variable names
 * Remove documentation from Screen.cpp file
 * Create Screen.dox documentation file



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42984 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-10-29 21:51:43 +00:00
Adrien Destugues
c647837666 * Add some details on how the Locale and the formater classes relate and which 
one one should use.
 * Add documentation for BDurationFormat.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42976 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-10-29 19:56:05 +00:00
Alex Wilson
7ab5610ba9 Update layout docs for LayoutInvalidated() changes. 2011-10-28 14:17:02 -06:00
Alex Wilson
4e0131f51b Rename BLayout::DerivedLayoutItems() to DoLayout(), which is consistent with BView::DoLayout(). Also adjusted child classes and documentation. 2011-10-28 14:16:25 -06:00
Alex Wilson
676c618ad7 Add a little info to the BLayout docs. 2011-10-28 14:16:22 -06:00
Adrien Destugues
fd4f34da56 Remove extra parameter to function call in documentation. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42859 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-10-16 10:02:10 +00:00
Adrien Destugues
68eccf0d5c The description for frameMoved and FrameResized was wrong. Thank Skipp_OSX for noticing. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42695 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-27 19:41:09 +00:00
Adrien Destugues
07658a130e Add some documentation for find_directory. This is very incomplete yet. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42694 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-27 09:15:50 +00:00
Adrien Destugues
d51bfbb57c Patch by John Scipione again : fix the new BIconUtils documentation. 
thanks!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42609 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-09 21:57:31 +00:00
Adrien Destugues
a33f8fbdec Merge work by John Scipione on the Haiku Book. 
* Some new classes documented
 * Screenshots for the interface kit controls
 * A lot of typo fixes
 * Some css tweaks

This has some backporting to the current version of Doxygen, since 
there are experiments to get coloring similar to the one in the Be 
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-09 21:46:13 +00:00
Adrien Destugues
61a02f6d99 * Add the header file to doxygen, too 
* Fix copypaste error.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42607 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-09 19:39:10 +00:00
Adrien Destugues
ca2c99c2ca * Add BIconUtils documentation to the Haiku Book 
* Remove comments from the header itself.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42606 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-08-09 19:31:46 +00:00
Niels Sascha Reedijk
3d2b623f71 Update the header to reflect the height of the logo image, which is 84px instead of 86px. See the discussion on r41337 on haiku-commits. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41362 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-05-07 08:09:57 +00:00
Joachim Seemer
36883d1e5b Fixing some typos, found by John Scipione and some by myself. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41361 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-05-07 05:58:20 +00:00
Jonas Sundström
7485fe842b Typo correction. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40722 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-02-27 11:17:18 +00:00
Philippe Houdoin
7f08510a9a Better to have consistent paths... 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40550 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-02-18 12:32:18 +00:00
Philippe Houdoin
a7e6888c00 Updated to reflect actual paths these days. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40549 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-02-18 12:08:31 +00:00
Alex Wilson
7e8daebe34 Fix a few typos in Locale kit documentation. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40521 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2011-02-15 20:26:52 +00:00
Adrien Destugues
15352f8de6 Fix missing \fn. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39706 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-12-02 18:40:15 +00:00
Adrien Destugues
01c2a7f38f Some inprovements suggested by Stippi and tqh. Thanks! 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39697 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-12-01 20:12:28 +00:00
Adrien Destugues
2d14fc1b97 Major improvement to the support kit introduction, done as part of gci by InsDel (Thanks!). 
Again, review welcome on this in order to decide if we carry on asking students to write api reference pages.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39696 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-12-01 19:40:02 +00:00
Adrien Destugues
6ec25bba48 Add documentation for BBox class, done by Clark Gaebel as part of GCI 2010. 
I did rework the text a little.

I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference.
I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-11-30 21:06:09 +00:00
Alex Wilson
cc19e7c0ff Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-10-23 02:33:08 +00:00
Alex Wilson
a46d62a268 Fix some typos in archiving documentation. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-10-23 01:51:37 +00:00
Oliver Tappe
b0c3ed0447 * fix a couple of typos 
* removed a sentence that's no longer true

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39024 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-10-20 17:32:29 +00:00
Oliver Tappe
6f43fabafb * some cleanup in BLocaleRoster 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39018 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-10-20 09:23:06 +00:00
Adrien Destugues
0d858bd391 Add documentation for the BTimeZone class. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38130 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-16 07:23:42 +00:00
Alex Wilson
886c23bf8b Update doxygen docs for recent changes to BArchivable, also document the BArchiver and BUnarchiver classes, and add a not in compatibility.dox. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38035 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-11 22:09:14 +00:00
Adrien Destugues
7ea3a2b029 Add note about the fact that locale kit is not part of libbe 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38020 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-11 12:39:29 +00:00
Adrien Destugues
a8a3468a80 * Add documentation for the UnicodeChar class. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38018 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-11 12:33:47 +00:00
Axel Dörfler
4bfbfb4da5 * Corrected compatibility note. I wonder why I share my wisdom on the public 
mailing list if I am then asked to do the work myself ;-)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38016 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-11 12:00:47 +00:00
Adrien Destugues
cae874d384 * Lots of fixes and proofreading to the locale api reference 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38010 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-11 08:09:12 +00:00
Adrien Destugues
e82e8f365e * Update locale kit documentation. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38004 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-10 12:39:48 +00:00
Adrien Destugues
3290008f1e * Add the warning and info boxes from userguide. However, I don't know how to upload the associated images to the api 
server.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37981 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-09 08:46:16 +00:00
Adrien Destugues
4db75e5128 * Fix typo pointed out by umccoullough. I should get a real keyboard. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37977 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-08 17:29:32 +00:00
Adrien Destugues
e579ff38fb * Added a note about the network libraries being incompatible with BeOS. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37976 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-08 16:20:09 +00:00
Adrien Destugues
5393193d0a * Fix some typos in the API reference for BLocale and BCatalog. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37950 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-07 14:08:05 +00:00
Adrien Destugues
0a4e27c50b * Fixed the main page entry for locale kit 
* Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff
 * Add some docs on date formatting to BLocale


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-05 12:09:20 +00:00
Adrien Destugues
c6247544ed * Add the locale kit to the main page 
* Complete and correct some parts of locale and catalog classes reference
 * Ensure the methods are prefixed with the class name so doxygen knows where they belong.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37898 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-04 12:01:38 +00:00
Adrien Destugues
e9fd63ec7c * Fix some outdated information in documentation files 
* Add a very small part of documentation about the Locale Kit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-08-03 16:02:55 +00:00
Ingo Weinhold
1a38616f35 Fixed fs_vnode_ops::create() documentation: The function shall not fail, if 
the file already exists, unless O_EXCL has been specified. At least that's
how our file systems with write support implement it.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37554 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-07-17 16:00:48 +00:00
Ingo Weinhold
1f23605dd7 Added description for fs_volume_ops::get_vnode()'s _type and _flags 
parameters.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37552 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-07-17 15:39:39 +00:00
Philippe Houdoin
18d844d2d9 Long forgotten update about the new vector icon added to midi endpoint under Haiku. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37528 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-07-15 18:34:25 +00:00
Niels Sascha Reedijk
ae15171716 Update the SupportDefs documentation for several changes and document the atomic_* functions. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35148 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2010-01-18 23:14:46 +00:00
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
Ingo Weinhold
8338b05a30 More FS interface documentation. All FS hooks required for writing a basic 
read-only FS are documented, now. Be encouraged to review and add more. :-)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20568 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-04-04 23:46:05 +00:00
Ingo Weinhold
3458a335ab Started documenting the FS API a bit. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-04-04 01:27:50 +00:00
Niels Sascha Reedijk
9889ca4a68 * book.dox Reformat according to the guidelines 
* BufferIO.dox Reformat according to the guidelines
* DataIO.dox Reformat according to the guidelines
* Flattenable.dox New documentation.
* Locker.dox Finished documentation.
* SupportDefs.dox Reformat according to the guidelines

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20511 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-04-02 11:39:10 +00:00
Niels Sascha Reedijk
e24e2c66c9 Push some doc changes I have on my harddrive. They don't (all) conform to the guidelines, but I wanted to put these in the repository nonetheless. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20472 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-03-30 13:50:00 +00:00
Niels Sascha Reedijk
a38ee20f99 Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-03-19 09:38:47 +00:00
Niels Sascha Reedijk
89e18a513c * Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo. 
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-03-02 13:36:32 +00:00
Niels Sascha Reedijk
9d54b14368 * Add documentation for BAutolock, BBlockCache and BList 
* Finish up documentation for BString
* Trying to work a bit more on the structure.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20236 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2007-02-26 10:34:35 +00:00
Niels Sascha Reedijk
089b7ad4c6 Some more work on the Doxygen version of the haiku_book. 
I will keep working on the Docbook version, but as I'm still not completely comfortable with that as final choice, I'm playing around with this as well.

The String.cpp file contained doxygen documentation for almost all methods, I copied those to a new file (string.dox) and grouped them accordingly. (Done because Axel is absolutely against in-header or in-source docs)

Integrated the BMidiConsumer and BMidiLocalConsumer class into the same file (like I did now to the producers), since I think it's better to keep a 1:1 relation with the headers. 

Removed the mididefs.dox file and replaced it with the midi2/Midi2Defs.dox file which actually documents the Midi2Defs.h file, rather than contain a custom page that was somewhat hard to find.

Please see http://www.myhouserules.nl/haiku_book/index.html for a generated book from the current source. I actually quite like the output so far, though I'm aware of the fact that I needed to perform some tricks to let Doxygen get to this point.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19651 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-12-29 00:26:34 +00:00
Niels Sascha Reedijk
515dc58881 Play around with doxygen a bit more, since I don't want to give up on it just yet. 
Started 'copying' some comments from the String.cpp file. 

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19642 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-12-27 17:46:38 +00:00
Niels Sascha Reedijk
d419ca3b7b Update API documentation and Doxyfile to improve the output. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-12 12:13:49 +00:00
Niels Sascha Reedijk
e932ec1af2 Revert earlier removal. 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18801 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-11 08:50:10 +00:00
Niels Sascha Reedijk
61da80a80a This documentation is converted to docbook. 
Check the trunk/src/documentation/haiku_book subdir.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18791 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-10 17:18:21 +00:00
Niels Sascha Reedijk
cf6a825f1f Move the UI guidelines to src/documentation location and add a Jamfile for compilation 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18768 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-05 21:24:56 +00:00
DarkWyrm
f4458b2588 Removed a few misspellings 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18735 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-02 19:54:22 +00:00
DarkWyrm
e23bf5454e Finished the appendix and converted guidelines to DocBook 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18734 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-09-02 13:19:06 +00:00
DarkWyrm
f30d1a521a Some initial revisions for the first 11 chapters or so 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18292 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-07-27 01:30:57 +00:00
DarkWyrm
6fd4020e03 Finished Chapter 12 and all of 13. Now comes proofreading and revising. *heh* 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18290 a95241bf-73f2-0310-859d-f6bbb57e9c96
 2006-07-26 20:37:13 +00:00