[Freeciv-Dev] Re: (PR#12643) Unify comments for gui specific client functions

["Jason Short" <jdorje@xxxxxxxxxxxxxxxxxxxxx>]

<URL: http://bugs.freeciv.org/Ticket/Display.html?id=12643 >

Raimar Falke wrote:
> <URL: http://bugs.freeciv.org/Ticket/Display.html?id=12643 >
> 
> 
> Hello
> 
> As you know the comments for the gui specific functions declared in
> client/include/* are written above the actual implementations. This
> produces quite a bit of redundancy. Also when you create a new
> function you have to copy it all over the place.
> 
> To remove this problem I suggest that we only update gui-stub and than
> use a script to update all other gui directories.
> 
> However before we can do this we have to unify the comments which
> exists right now in the various files and update the gui-stub files
> with the most accurate version.
> 
> The attached output should help in this regard. To interpret it's
> output I explain one function here:

Since I more-or-less actively maintain gui-stub, its comments should in 
almost all cases be the best ones.  In particular I think no function 
there is uncommented.

-jason