Commit Graph

162 Commits

Author SHA1 Message Date
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
9662cf00d7 Remove useless file.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20208 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-02-23 15:29:33 +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
Stephan Aßmus
d01c27d4f1 * documenting small addition to protocoll when handling flat vector icon data
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19190 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-11-03 09:41:20 +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
Ingo Weinhold
6bfd06d1ff BRoster::Launch() eventually launches the application in question
in several steps:
1. early pre-registration with the registrar ("I wanna launch the
   app, make sure noone interferes.")
2. load the app image
3. finish pre-registration with the registrar ("I have launched
   the app, here is its team ID.")
4. start app main thread
5. send "on launch" messages to the app (argv, refs, others)

If the app is already running or being launched, 1. fails with a
conclusive error code and returns the team ID and the pre-registration
token of the app. Steps 2 - 4 are skipped and only the messages are
delivered using the team ID returned by 1.

This change fixes a race condition: The failed early pre-registration
request obviously cannot return the team ID, if the other thread
launching the app has not finished step 3 yet. Thus the argv/refs
message would not get delivered and Launch() would not return the
correct team ID.

Now we wait for the pre-registration to be finished in this case, using
the former _IsAppPreRegistered() mechanism, which already provided
such a waiting feature for one request. It has been extended to
accomodate an arbitrary number of waiting requests and renamed to
_IsAppRegistered().

This fixed bug #763.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18728 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-08-31 17:54:16 +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
DarkWyrm
34a892a1c1 Miscellaneous cleanups, slight restructuring of chapters, Chapter 10 is finished and Chapter 11 is well on its way
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18274 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-25 22:51:56 +00:00
DarkWyrm
375837b47b Finished Chapter 10 and started Chapter 11, including how to properly use a BAlert
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18261 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-25 14:14:11 +00:00
DarkWyrm
edde06446f Finished up chapter 7 and added all of chapter 8 and most of 9.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18244 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-22 18:50:33 +00:00
DarkWyrm
8952c21441 Finished Chapter 6 and started Chapter 7
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18242 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-21 23:39:47 +00:00
Axel Dörfler
cd1e67ac69 Reworked the parts that are affected by the reintroduction of the datalink module.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18239 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-21 09:48:33 +00:00
Axel Dörfler
7e24384c6e Added the basic overview for the stack that I posted to the list.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18238 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-21 09:34:45 +00:00
Axel Dörfler
c25e9351af * Removed some superfluous documents.
* Moved the documentation that might still be helpful into an "obsolete" directory.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18237 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-21 09:33:34 +00:00
DarkWyrm
601e41243c Added some stuff to chapter 6 and did a little reorganizing of 6's topics
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18002 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-01 21:15:55 +00:00
Jérôme Duval
0e8c81c72c hey is in bin/ , kept the user guide in docs/bin/hey.html
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17811 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-06-13 08:54:19 +00:00
DarkWyrm
c310520d82 Added some tweaks as suggested by Stephan
Roughed in quite a lot of chapter 5


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17794 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-06-11 01:46:27 +00:00
DarkWyrm
2dd195c30a A couple more chapters added and some revisions made to existing ones to make things a little less boring to read.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17748 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-06-07 00:20:07 +00:00
DarkWyrm
2af6c95389 More work on chapter 3
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17576 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-05-24 10:40:35 +00:00
DarkWyrm
57c361471e Started work on Chapter 3, which deals with general OS conventions. Still rough stuff.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17517 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-05-20 01:34:46 +00:00
DarkWyrm
348f3a067c Added initial rough chapters for some UI guidelines. Docbook formatting will come later.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@17516 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-05-20 00:48:04 +00:00
Marcus Overhagen
24159a0c7d imported Cortex 2.1.2 documentation
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@16642 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-03-08 13:30:15 +00:00
Ingo Weinhold
15424f3d37 Finally fixed update_mime_info(). As Be's version it understands two
different "force" levels now and updates the app file info attributes
for shared object files.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@16123 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-01-28 19:41:07 +00:00
Alexander G.M. Smith
c181c43dc1 More documentation moved over from SourceForge, so it's not quite up to date.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@15965 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-01-15 22:43:21 +00:00
Alexander G.M. Smith
68b4d23acc Documentation copied over from MDR project on SourceForge.net.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@15963 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-01-15 22:35:29 +00:00
Michael Lotz
69db808ea3 Add a documentation of the Dano message format. These are my findings from looking at flattened Dano messages. I will adjust the Dano message reader accordingly.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@14725 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-11-07 00:17:34 +00:00
Ingo Weinhold
2fd4a0411b Added a boolean "synchronous" parameter to BRoster::Shutdown(). Used in the
Deskbar to initiate the shutdown process asynchronously. Couldn't test it,
because opening the Be menu doesn't work:
***PANIC: BW: Can't find view with ID: 19 !***



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13722 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-17 16:37:11 +00:00
Ingo Weinhold
a13df0dc01 Added a "confirm" parameter to BRoster::Shutdown() which causes the registrar
to ask the user to confirm shutting down the system.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13563 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-09 20:23:28 +00:00
Ingo Weinhold
925d069d23 * Added BRoster::ShutDown().
* Adjusted the shutdown command to use BRoster::ShutDown(). Removed
  the alert.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@13416 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-07-03 17:04:47 +00:00
Axel Dörfler
24cea645f1 Moved all documentation out of the device_manager.h header file to this place.
We might want to use it as a basis for the device manager documentation.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@12634 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-05-11 16:40:13 +00:00
Axel Dörfler
7e3d359491 Added support kit and some POSIX headers to the doxyfile.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11735 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-03-14 16:34:03 +00:00
Axel Dörfler
b7a1b23415 Added a brief description of the syslog functions I had laying around here.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11734 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-03-14 16:27:04 +00:00
Axel Dörfler
ec15a3e18f Added the support kit to the docs (doesn't seem to be maintained these days,
but won't harm either).


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11733 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-03-14 16:22:59 +00:00
Niels Sascha Reedijk
6256385fde *** empty log message ***
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11251 a95241bf-73f2-0310-859d-f6bbb57e9c96
2005-02-04 21:23:13 +00:00
Axel Dörfler
034b417e13 Forgot to commit this some years ago: minor update :)
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@9867 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-11-08 17:34:00 +00:00
ejakowatz
380156b567 Clarified the format, in particular with regard to how 'mini' vs. 'maxi'
data effects field sizes.


git-svn-id: file:///srv/svn/repos/haiku/trunk/current@9742 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-11-02 20:49:35 +00:00
Ingo Weinhold
eb98f8c339 Squashed several TODO items by changing the Storage Kit <-> Kernel interface.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@8691 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-08-28 20:04:41 +00:00
Philippe Houdoin
7d374a5e1c s/OpenBeOS/Haiku/g on html pages.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@8522 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-07-30 17:05:14 +00:00
Waldemar Kornewald
700c9b5dad Added initial PPP API documentation.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-06-01 14:58:47 +00:00
mahlzeit
a435c710ab Updated to-do list.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7579 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-05-14 15:00:06 +00:00
mahlzeit
e16d0060fe More docs.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7577 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-05-14 09:49:32 +00:00