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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
a808adb023
blah blah blah
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7572 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-05-13 20:42:46 +00:00
5b4453a4e5
Made sysex a little clearer.
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@6459 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-02-01 13:10:57 +00:00
d0db65a53f
Added a header (not yet used by the current Doxygen file) for use with
...
the BeBook style docs.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4390 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 03:48:16 +00:00
c04f2d92ca
Added a \brief for the file.
...
Now uses <span class="var"> instead of \p for variables in the text.
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4389 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 03:46:29 +00:00
d99a9fa0a5
Hacked together a BeBook style derivation of the standard doxygen.css
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4388 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 03:44:59 +00:00
9a230c2672
Fixed using \subsection without a \section (replaced all subsections by sections).
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4387 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 03:19:26 +00:00
4d00ee5ddd
Added doxygen documentation for the parsedate() function.
...
Tried to get right with doxygen, but it ain't easy...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@4386 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-08-27 02:34:47 +00:00
cc58a05e1a
added docs for Tempo Change event
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2928 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-03-17 22:19:49 +00:00
86ec86b378
small clarification
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2927 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-03-17 22:18:09 +00:00
0524a6a89d
Added Midi Kit end-user documentation.
...
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@2881 a95241bf-73f2-0310-859d-f6bbb57e9c96
2003-03-11 18:52:03 +00:00
Niels Sascha Reedijk