Steven,
How different is the methodology used in wine from the one we want to introduce in reactos?
From what I understand wine uses a tool (doesn't matter which one now) to
parse C source files, extract function information (description , parameters, ...) from a more or less custom formatted header before each function and outputs HTML reports from it.
When I proposed to seriously use rgenstat on our core APIs I was thinking about doing something similar in concept but with a different implementation. Rgenstat is the C equivalent to the c2man script that inset of directly output formatted HTML outputs an xml database that is used as an intermediate format to generate HTML or whatever other format we may require in the future. The better solution for me is extending rgenstat to parse an strict doxygen style header with may be a few custom aditions (attributes) like @implemented/@unimplemented , @fixme , @winversion .... that make sense for our project.
It has the advantage that the same information from these headers can be used by doxygen to produce rich HTML in addition and for our custom API traking reports with our own particular information so from my point of view rgenstat (with a few modifications and enchantments to the parser) is more than sufficient.
Regards, /Marc
PS: The parser should be also tolerant to wine-style headers, of course.
-----Original Message----- From: ros-dev-bounces@reactos.org [mailto:ros-dev-bounces@reactos.org] On Behalf Of Steven Edwards Sent: Saturday, November 10, 2007 8:16 PM To: ReactOS Development List Subject: Re: [ros-dev] Tracking implementation API status
On Nov 10, 2007 4:00 AM, Aleksey Bragin aleksey@reactos.org wrote:
Hi, no, I was speaking about something different. Take a look - http://www.reactos.org/wiki/index.php/Coding_Style there I mean this:
The implemented/unimplemented tags are really worthless because what if the API takes 20 params and 18 of them are implemented and nothing known uses the other 2 params? Do you call it implemented or unimplemented? Its better to autogenerate the docs from the function comment headers. See here, I think this is a MUCH better system and it already works. No point in developing another.
http://source.winehq.org/WineAPI/
If the API does not show up in the documented API then it should be safe to assume its not implemented. If it is implemented and not documented then its a Janitorial project.