[haiku-doc] Re: Simple patch Doxyfile

Hi Alan,

2007/5/22, Alan Smale <ajsmale@xxxxxxxxx>:

I've been looking at reducing the warnings generated by Doxygen when it is
run against the docs directory. It would be good to get rid of them.


The two only sources of warning are now the fs_interface.h and the
USB_spec.h. As you can see, both of them are claimed. I am working on
the fs_interface.h file, and I actually have a version on my hard
drive that works around the warnings. It needs a bit more work of
actually documenting things, but if the warnings bother you too much,
I can commit a sort of inbetween version. As of USB_spec.h the problem
is a bit more technical. Currently, the structures have the _PACKED
attribute, which tells the compiler that it should not try to optimize
the structure for memory. I have asked Michael Lotz whether or not
this attribute could be cleared, but he has not yet responded.


I've made a start with the Doxyfile. I observed the following warnings:
(...
I have run the "doxygen -u" command as suggested. The attached diff file is
the result. It seems to have cured the problem. There are plenty more
warnings to fix though :-)


These options or warnings come from the fact that the original
Doxyfile was created with Doxygen 1.5.1. The newest release is 1.5.2,
which changes some options. Since there is no 1.5.2 build for BeOS
yet, I have not yet updated the Doxyfile to use the latest switches.
Even though I don't think it will actually cause any problems, I can't
test it so I'm waiting for that build. (How's it going, CJ?)


Does this patch look ok as I am in the hands of the Doxygen gods with this
one!


There is one custom comment I made with regard to preprocessor
defines. If you could heave that over to your patch, that would be on
the safe side.


Will be offline for a few days (on a work course) so I'll deal with any
comments you may have this weekend when I'm back.


I might manage to update the fs_interface.h file, and we might have a
working doxygen 1.5.2 build. Then I will commit this patch.

Niels

Other related posts: