This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.

Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]
Other format:	[Raw text]

Re: [PATCH]: Add documentation for functions in tree-flow-inline.h

From: Mark Mitchell <mark at codesourcery dot com>
To: Daniel Berlin <dberlin at dberlin dot org>
Cc: GCC Patches <gcc-patches at gcc dot gnu dot org>
Date: Tue, 15 Jun 2004 11:04:13 -0700
Subject: Re: [PATCH]: Add documentation for functions in tree-flow-inline.h
Organization: CodeSourcery, LLC
References: <1C733CAA-B7D9-11D8-909E-000A95DA505C@dberlin.org> <40CF107D.9060408@codesourcery.com> <2329F56A-BEF5-11D8-AF3E-000A95DA505C@dberlin.org>

Daniel Berlin wrote:

On Jun 15, 2004, at 11:06 AM, Mark Mitchell wrote:

Daniel --

These functions are all missing comments. There should be a comment for every parameter and an explanation of the value returned.

Okey.

As penance, I also added comments for all the other functions in that file, which were all missing this documentation.

I've attached the patch for review

Yay! Looks good.

--
Mark Mitchell
CodeSourcery, LLC
mark@codesourcery.com

References:
- [PATCH]: Add annotations for expression and constants
  - From: Daniel Berlin
- Re: [PATCH]: Add annotations for expression and constants
  - From: Mark Mitchell
- [PATCH]: Add documentation for functions in tree-flow-inline.h
  - From: Daniel Berlin

Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]