[haiku-doc] Re: Problems with docs

Niels Reedijk wrote:

2009/2/14 Christian Packmann <Christian.Packmann@xxxxxx>:



Working on that one actually. It is the file system API which has
changed dramatically.


Great. Then I don't have to volunteer for that. :)


I also noted that the online version of the Haiku Book at
http://factory.haiku-os.org/documentation/Haiku_Book_doxygen/html/ seems to
be severely outdated - it's supposed to be a nightly build, but the
generation date is 2008-02-14, which is a slight bit old. Any chance of
fixing this?


Yes, but not really a priority right now.


Hmm, if we make some progress with the docs, could we at least put an 
occasional snapshot up, even if the nightlies remain broken? Of course this 
will only be relevant if we get some progress with the docs, but I hope I'll 
find the time to get some stuff done.


Which part of the driver documentation were you planning on working on?


I've started with the poke driver. Right now I'm still experimenting with 
Doxygen and testing out how to present the information. Once I got a 
presentable draft, I'll let you know. I might work on other parts later, but we 
can talk about that when I get the first docs finished.

Oh, and I probably won't be able to fully document the poke driver, this 
depends on how well I'll be able to understand the PCI config interface. While 
I am a programmer, I'm not too familier with our kernel. I hope it would be 
okay if some parts of the doc would only be an outline without much actual 
content. I think it's better to get some progress, even if incomplete, than to 
wait for a perfect solution. I hope this doesn't clash with your ideas about 
this.

And maybe if we get a outline of the docs done, we could convince our kernel guys to write 
something if we can point them to some doc and say "Type here->", instead of 
having them learn Doxygen and formatting pages...

Christian

Other related posts: