[haiku-doc] Re: Problems with docs

  • From: Niels Reedijk <niels.reedijk@xxxxxxxxx>
  • To: haiku-doc@xxxxxxxxxxxxx
  • Date: Sun, 15 Feb 2009 13:24:53 +0100

2009/2/14 Christian Packmann <Christian.Packmann@xxxxxx>:
> Hi all,
> I want to work on the driver documentation, but ran into problems.
> According to the HOWTO in trunk/docs/user, I should only need to run doxygen
> from this directory. This works in principle, but throws a mess of errors
> about missing links. This is not too good, as I can't see my own errors
> then. :) This happens on Haiku-GCC2, Linux and Windows/Cygwin, so it's not
> machine-specific.

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

> 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.

> Oh, and the HOWTO in trunk/docs/user states that the docs can be contained
> either in separate files or in the source files themselves, while the
> appropriate section in the Haiku Book
> (http://factory.haiku-os.org/documentation/Haiku_Book_doxygen/html/apidoc.html)
> explicitely states that documentation should be in its seperate tree. It
> would be nice if this could be unified either way - such guidelines should
> be consistent.

I am going to remove the HOWTO, it is severely outdated anyway.

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

Kind regards,


Other related posts: