freetype-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: latest formatting updates


From: Werner LEMBERG
Subject: Re: latest formatting updates
Date: Mon, 06 Nov 2000 08:28:46 +0100 (CET)

> By the way, a final point regarding formatting. It's related to the
> location of the "*" in function signatures. The rules are:
> 
>   - the "*" is normally part of the type, and should be put on
>     the left in a parameter or variable declaration, as in:
> 
>         foobar*     foo;
> 
>   - however, when declaring/defining an "out" parameter (or "inout" one),
>     one "*" must be placed on the right in order to denote this, as in:
> 
>         FT_New_Face( FT_Library     library,
>                      FT_Face       *aface );
> 
>     where the "*" is used to indicate that "aface" is returned.

I've updated convntns.txt and started to apply it.

Related to this, I again ask to remove the double comments of exported
functions.  For example, if I update the comment for, say,
FT_Init_FreeType() in freetype.h, I have to repeat that in ftinit.c --
I really prefer just one comment (in the header file), replacing the
comment in the source file with

  /* this function is documented in freetype.h */

Avoiding redundancy increases the quality of documentation enormously,
even if it may be a bit inconvenient to check two files...

Addionally, the library becomes smaller by 50kByte or so.


    Werner



reply via email to

[Prev in Thread] Current Thread [Next in Thread]