Re: Moved dll list from DEVELOPERS-HINTS into separated file

2004-11-29 Thread Jon Griffiths
Hi,

>I personally don't think it's really useful without more detailed
>information on each dll, but in any case this belongs to one of the
>sgml documents, not a stand-alone ASCII file.

c2man.pl will generate a blurb for each dll in the source tree when
building API docs, if one of the dlls source files contain a
supplimental comment named after the dll. IMHO this is the best place
to put a description of the dll. It appears in the generated docs
above the list of exported functions and makes a natural lead-in to
the dlls documentation page. The info is then also available by "man
dllname" if the generated docs are installed. 

See the top comment in dlls/shlwapi/shlwapi_main.c for an example.

Cheers,
Jon


=
"Don't wait for the seas to part, or messiahs to come;
 Don't you sit around and waste this chance..." - Live

[EMAIL PROTECTED]



__ 
Do you Yahoo!? 
All your favorites on one personal page – Try My Yahoo!
http://my.yahoo.com 



Re: Moved dll list from DEVELOPERS-HINTS into separated file

2004-11-28 Thread Alexandre Julliard
"Dimitrie O. Paun" <[EMAIL PROTECTED]> writes:

> On Fri, Nov 26, 2004 at 10:04:49PM -0500, Jacek Caban wrote:
> > I saw in TODO list "Get rid of the list of DLLs, it's too big, and adds 
> > too little information",
> > so I thought it could be moved into separated file dlls/DLL-LIST. 
> 
> I think this is a good idea: while I agree that the list is a bit
> much for DEVELOPERS-HINTS, it's still a nice overview of the dlls 
> we have, and it would be a real pitty to lose.

I personally don't think it's really useful without more detailed
information on each dll, but in any case this belongs to one of the
sgml documents, not a stand-alone ASCII file.

-- 
Alexandre Julliard
[EMAIL PROTECTED]



Re: Moved dll list from DEVELOPERS-HINTS into separated file

2004-11-26 Thread Dimitrie O. Paun
On Fri, Nov 26, 2004 at 10:04:49PM -0500, Jacek Caban wrote:
> I saw in TODO list "Get rid of the list of DLLs, it's too big, and adds 
> too little information",
> so I thought it could be moved into separated file dlls/DLL-LIST. 

I think this is a good idea: while I agree that the list is a bit
much for DEVELOPERS-HINTS, it's still a nice overview of the dlls 
we have, and it would be a real pitty to lose.

-- 
Dimi.