From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mats Petersson Subject: Re: [PATCH] Add doc-comment to get_domain_by_id Date: Fri, 18 Jan 2013 14:08:44 +0000 Message-ID: <50F9576C.2050307@citrix.com> References: <9662deb217d7869d35dc.1358516092@localmatsp-T3500> <1358517777.3279.48.camel@zakaz.uk.xensource.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii"; Format="flowed" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <1358517777.3279.48.camel@zakaz.uk.xensource.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: Ian Campbell Cc: "xen-devel@lists.xen.org" List-Id: xen-devel@lists.xenproject.org On 18/01/13 14:02, Ian Campbell wrote: > On Fri, 2013-01-18 at 13:34 +0000, Mats Petersson wrote: >> # HG changeset patch >> # User Mats Petersson >> # Date 1358516011 0 >> # Node ID 9662deb217d7869d35dce5587ae8a1b45296b3a0 >> # Parent 126ce5f1855ba21ae24fc1c0981e5c05a3245bad >> Add doc-comment to get_domain_by_id >> >> diff --git a/xen/common/domain.c b/xen/common/domain.c >> --- a/xen/common/domain.c >> +++ b/xen/common/domain.c > We normally put these comments in the header next to the protoype. Ok, I can move it... ;) > >> @@ -373,7 +373,16 @@ >> free_cpumask_var(cpumask); >> } >> >> - >> +/** > Nothing in the Xen infrastructure parses these sorts of headers and > practically nowhere else uses them. I'd say just make this a regular > comment. And there I was searching for "how do you do doxygen style comments" after having written a normal one, just so I could avoid being told that "You should use doxygen format... " ;) I guess that's why I couldn't trivially find something. -- Mats > > Ian. >