Developer Database/Library

Suggestions and comments about the ReactOS website

Moderator: Moderator Team

Post Reply
ThePhysicist
Developer
Posts: 509
Joined: Mon Apr 25, 2005 12:46 pm

Developer Database/Library

Post by ThePhysicist »

I think that ReactOS needs some kind of developer database. Like MSDN Library.
It should include documentation of all the source files (location, what functions does it implement, ...) and documentation about the functions itself (parameters, return values, what does the function).
OK, there's Doxygen, but it's missing the real documentation. In fact it cuts away the existing documentation.
And C-code is not always self-explanatory ;-)

I think it would make development for ROS easier and might attract other developers, if it contains undocumented windows functions.

It could be done like wine does it from inside the source code. And this could be updated regularly by a script.
Example of Wine documentation:

Code: Select all

/***********************************************************************
 * InitCommonControlsEx [COMCTL32.@]
 *
 * Registers the common controls.
 *
 * PARAMS
 *     lpInitCtrls [I] pointer to an INITCOMMONCONTROLS structure.
 *
 * RETURNS
 *     Success: TRUE
 *     Failure: FALSE
 *
 * NOTES
 *     Only the additional common controls are registered by this function.
 *     The Win95 controls are registered at the DLL's initialization.
 *
 * FIXME
 *     implement the following control classes:
 *       ICC_LINK_CLASS
 *       ICC_STANDARD_CLASSES
 */
Additional information, that may be too much to put it into the code (like tables with allowed paramters, etc.) could be linked to / included from external documentation files. Like {CodePage table} would include a table from an external source called "CodePage table" and "Also see [GetLastError]." would create a link to GetLastError.

What do you think?
frik85
Developer
Posts: 829
Joined: Fri Nov 26, 2004 7:48 pm
Location: Austria, Europe
Contact:

Post by frik85 »

First, the support database (one part of it is the compatibility database) has already some interfaces for such a project:
http://www.reactos.org/support/index.ph ... t&sec=home
Which would allow us to create something like MSDN.

And, there is a plan to use a similar script like WineHQ to list all (Win)API functions which are available in ReactOS. And we had already a script which show the progress of all WinAPI functions in persent.
ThePhysicist
Developer
Posts: 509
Joined: Mon Apr 25, 2005 12:46 pm

Post by ThePhysicist »

frik85 wrote:First, the support database (one part of it is the compatibility database) has already some interfaces for such a project:
http://www.reactos.org/support/index.ph ... t&sec=home
Which would allow us to create something like MSDN.
Oh, yes, now I remember having seen it some time ago.
frik85 wrote:And, there is a plan to use a similar script like WineHQ to list all (Win)API functions which are available in ReactOS.
But it looks like the source code is still lacking of much documentation ;-) Now that the audit takes place, maybe the devs could also document the audited functions. A TODO/FIXME list would be nice, so devs/other people could look for things they can fix/implement.
frik85 wrote:And we had already a script which show the progress of all WinAPI functions in persent.
Yes, where's that nice API-Status page?
Post Reply

Who is online

Users browsing this forum: No registered users and 9 guests