Re: [Tinycc-devel] tcc coding style question

[Michael Matz]

Hi,

On Thu, 24 Jan 2019, Christian Jullien wrote:

> Hum! Unrelated question, I'm a big fan of Doxyen which I use on all 
> projects I own, I'm asking if we want start to move to Doxygen for 
> public API. I can make project infrastructure (but of course not 
> associated Doxygen tags).

I personally find Doxygen markup to just clutter sources.  I want the 
source code to be self-contained, including useful comments; the idea of 
post-processing to have useful docu goes counter to that.

It might make sense for libraries, where the public entry points should 
have documentation in a form that's separate from sources (but even there 
I've seen more useless Doxygen "docu" than useful ones), so perhaps it's 
sensible to create such docu for the library parts of TCC.

In any case I think adding infrastructure without also making use of it 
shouldn't be done.  So, if we have someone interested in writing docu for 
the library parts: super, let's add the infrastructure and the docu, 
otherwise let's wait until we do have someone ;)


Ciao,
Michael.

> 
> C
> 
> 
> -----Original Message-----
> From: Tinycc-devel [mailto:address@hidden
> On Behalf Of Michael Matz
> Sent: jeudi 24 janvier 2019 17:10
> To: address@hidden
> Subject: Re: [Tinycc-devel] tcc coding style question
> 
> Hi,
> 
> On Thu, 24 Jan 2019, Christian Jullien wrote:
> 
> > Question (to maintainers): do you allow me to fix them all?
> 
> Please don't.  It makes git blame unnecessarily hard.  You can fix style 
> issues when you change the code in question for other reasons.
> 
> (I'm probably responsible for some of the tabs, as other projects I'm 
> working on require tabs at line beginnings)
> 
> 
> Ciao,
> Michael.
> 
> _______________________________________________
> Tinycc-devel mailing list
> address@hidden
> https://lists.nongnu.org/mailman/listinfo/tinycc-devel
> 
> 
> _______________________________________________
> Tinycc-devel mailing list
> address@hidden
> https://lists.nongnu.org/mailman/listinfo/tinycc-devel
>