List:Internals« Previous MessageNext Message »
From:Guilhem Bichot Date:April 9 2010 8:21pm
Subject:Re: doxygen comments in header files
View as plain text  
Hello Kristian,

Kristian Nielsen a écrit, Le 06.04.2010 12:58:
> Tor Didriksen <Tor.Didriksen@stripped> writes:
> 
>> On 2010-03-31 11:53, Guilhem Bichot wrote:
> 
>>> http://forge.mysql.com/wiki/MySQL_Internals_Coding_Guidelines says

> Maybe I am taking some liberties in my interpretation of the coding standard
> about putting documentation at the place of implementation. But I have always
> interpreted it so that I would put documentation about the *interface* of a
> member function in the header. And documentation about the *implementation* of
> that member function in the .cc (unless it's inline in the .h).

I agree with your suggestion, but that's not quite what I read in:
"function and method comments should be placed in front of 
implementation rather than declaration. Class comments should be put in 
front of class declaration."
So I believe there is room for clarification of our guidelines :-)
Thread
doxygen comments in header filesGuilhem Bichot31 Mar
  • Re: doxygen comments in header filesTor Didriksen6 Apr
    • Re: doxygen comments in header filesGuilhem Bichot6 Apr
      • Re: doxygen comments in header filesMats Kindahl6 Apr
    • Re: doxygen comments in header filesKristian Nielsen6 Apr
      • Re: doxygen comments in header filesGuilhem Bichot9 Apr
        • Re: doxygen comments in header filesTimour Katchaounov11 Apr
          • Re: doxygen comments in header filesDavi Arnaut11 Apr
            • Re: doxygen comments in header filesDavi Arnaut11 Apr
            • Re: doxygen comments in header filesSergei Golubchik11 Apr
              • Re: doxygen comments in header filesGuilhem Bichot12 Apr
                • Re: doxygen comments in header filesTor Didriksen12 Apr
                  • Re: doxygen comments in header filesGuilhem Bichot12 Apr
                    • Re: doxygen comments in header filesTor Didriksen12 Apr
                  • Re: doxygen comments in header filesSergei Golubchik12 Apr
            • Re: doxygen comments in header filesMichael Widenius13 Apr
              • Re: doxygen comments in header filesDavi Arnaut13 Apr
    • Re: doxygen comments in header filesMichael Widenius6 Apr
      • Re: doxygen comments in header filesMARK CALLAGHAN6 Apr
        • Re: doxygen comments in header filesMichael Widenius13 Apr
  • Re: doxygen comments in header filesDavi Arnaut7 Apr
    • Re: doxygen comments in header filesGuilhem Bichot7 Apr
    • Re: doxygen comments in header filesKonstantin Osipov9 Apr
  • Re: doxygen comments in header filesIngo Strüwing12 Apr
    • Re: doxygen comments in header filesGuilhem Bichot15 Apr
      • Re: doxygen comments in header filesIngo Strüwing15 Apr
        • RE: doxygen comments in header filesVladislav Vaintroub16 Apr