Commit Graph

16 Commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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