Re: cleaning up FT2

[Werner LEMBERG]

> > You want all docs in the headers?  I'm not really happy about
> > this.  IMHO the natural flow of documentation should be in the .c
> > files instead -- .h files produce a synoptical view only, and
> > since we intend to extract the docs anyway, there is no special
> > need for a synopsis in the source code.
> >
> Well, I like to have structure and function descriptions in the
> public header files.  So let's say something like:
> 
>   - all header files in "freetype2/include" keep their comment
>     (these can stay in the corresponding C files, or not, as you
>     like) 

OK.  I'll then add something like `this function is documented in the
public header file xxx.h' to the .c files.  I really want to avoid
double documentation.

>   - in the case of type definitions, the comments are placed near
>     them, which is in the header file

Of course.

>   - there are no comments for function declarations (except in
>     "include"), as they should all be near the function
>     definitions. 

Agreed.  This should stay in the .c file.


    Werner