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
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
- 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
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
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
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
"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
"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
"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
- 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
* 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
* 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
* 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
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
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
Started documenting BStopWatch to test some things. This is probably not the final documentation of that class.
I stopped the tedious work of manually converting every Windows line-endings into UNIX line-ends. If this does cause problems for anyone, let me know and I'll do it.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19641 a95241bf-73f2-0310-859d-f6bbb57e9c96
Added skeleton of Archivable and Flattenable. Updated howo on how to handle static functions and pure virtuals.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19613 a95241bf-73f2-0310-859d-f6bbb57e9c96
Autolock, BlockCache and Locker are completely 'converted' into docbook. String is partial.
Added the beginnings of a 'Haiku Book Howto'. Made changes to the Jamfile, but I'm on windows so I'm unable to test whether or not it works.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19612 a95241bf-73f2-0310-859d-f6bbb57e9c96
There remains only one issue: reading the Port registers seem to return a bogus value (0). I need to find out what's causing it.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18918 a95241bf-73f2-0310-859d-f6bbb57e9c96
It includes a change to xsltproc to accept catalog paths on the command line.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18763 a95241bf-73f2-0310-859d-f6bbb57e9c96
* Started cleaning up the style (WIP)
* I'll slowly phase out ohci_software.h, since it is BSD legacy
* Cleanup other BSD inspired naming. I like full names.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18723 a95241bf-73f2-0310-859d-f6bbb57e9c96
It doesn't do anything yet, but it allocates the io registers properly and
now the values that are returned when reading it make sense.
More to come...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18673 a95241bf-73f2-0310-859d-f6bbb57e9c96
This change fixes that on non-haiku targets. Please note that the change is only needed on R5 and bone probably, but it won't do any harm on other build platforms either.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18551 a95241bf-73f2-0310-859d-f6bbb57e9c96
The OHCI stuff was done by Jixt (thanks)./installusb
All is still very much work in progress
Patches applied:
* [email protected]/usb-busses--development--0.1--base-0
tag of [email protected]/usb-busses--mainline--0.1--base-0
* [email protected]/usb-busses--development--0.1--patch-1
Set the PORT_STATUS_LOW_SPEED flag correctly (using the register bitflag for low speed devices, instead of the proper lowspeed flag)
* [email protected]/usb-busses--development--0.1--patch-2
Clean up transfers when they're done
* [email protected]/usb-busses--development--0.1--patch-3
* [email protected]/usb-busses--development--0.1--patch-4
* [email protected]/usb-busses--development--0.1--patch-5
* [email protected]/usb-busses--development--0.1--patch-6
* [email protected]/usb-busses--development--0.1--patch-7
Remove obsolete ehci.c
* [email protected]/usb-busses--development--0.1--patch-8
* [email protected]/usb-busses--development--0.1--patch-9
Completed memory allocation + initialization
* [email protected]/usb-busses--development--0.1--patch-10
First attempt at performing control transfers - failed miserably
* [email protected]/usb-busses--development--0.1--patch-11
Trying to read a 16bit value into a 8bit integer, stupid
* [email protected]/usb-busses--development--0.1--patch-12
nicer way of getting the base io address
* [email protected]/usb-busses--development--0.1--patch-13
Take over control from BIOS
* [email protected]/usb-busses--development--0.1--patch-14
Revert change for disabling USB BIOS support
git-svn-id: file:///srv/svn/repos/haiku/trunk/current@11743 a95241bf-73f2-0310-859d-f6bbb57e9c96
