From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124])
 by mx.groups.io with SMTP id smtpd.web10.2798.1601020671192870632
 for <devel@edk2.groups.io>;
 Fri, 25 Sep 2020 00:57:51 -0700
Authentication-Results: mx.groups.io;
 dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=Wl9dsqdJ;
 spf=pass (domain: redhat.com, ip: 63.128.21.124, mailfrom: lersek@redhat.com)
Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;
	s=mimecast20190719; t=1601020670;
	h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
	 to:to:cc:mime-version:mime-version:content-type:content-type:
	 content-transfer-encoding:content-transfer-encoding:
	 in-reply-to:in-reply-to:references:references;
	bh=z0dz1wQUW+LQYLSaJsQarZoBvuBAWQTXtOl8LCeGaNk=;
	b=Wl9dsqdJcdNTDMQwbMEcy040bbvcAl/nSsLLRMYd9j8pefFemtK2aYJ9DysdfVxq4w0AKW
	uG4gFl0Hr8P8rh88yLfxYJHwD8jTyL3o+xPDvTh+nwU+pKSNGgu4QTU49YkSbb3hgoBUj+
	kl589HO8JGN+2+Bad6vsQxogBuyM96I=
Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com
 [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id
 us-mta-192-xdbQic5aNeiCkIgPexn8Yg-1; Fri, 25 Sep 2020 03:57:46 -0400
X-MC-Unique: xdbQic5aNeiCkIgPexn8Yg-1
Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14])
	(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
	(No client certificate requested)
	by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 344FE802EA5;
	Fri, 25 Sep 2020 07:57:45 +0000 (UTC)
Received: from lacos-laptop-7.usersys.redhat.com (ovpn-112-178.ams2.redhat.com [10.36.112.178])
	by smtp.corp.redhat.com (Postfix) with ESMTP id 9E0965D9F1;
	Fri, 25 Sep 2020 07:57:44 +0000 (UTC)
Subject: Re: [edk2-devel] What is a special documentation block?
To: devel@edk2.groups.io, bret.barkelew@microsoft.com
References: <MW4PR21MB185777124D141CA5FA693619EF360@MW4PR21MB1857.namprd21.prod.outlook.com>
From: "Laszlo Ersek" <lersek@redhat.com>
Message-ID: <a4ee2bc6-2b57-2e2c-89f7-11759b900a28@redhat.com>
Date: Fri, 25 Sep 2020 09:57:43 +0200
MIME-Version: 1.0
In-Reply-To: <MW4PR21MB185777124D141CA5FA693619EF360@MW4PR21MB1857.namprd21.prod.outlook.com>
X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14
Authentication-Results: relay.mimecast.com;
	auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=lersek@redhat.com
X-Mimecast-Spam-Score: 0
X-Mimecast-Originator: redhat.com
Content-Type: text/plain; charset=windows-1252
Content-Language: en-US
Content-Transfer-Encoding: 8bit

On 09/25/20 03:16, Bret Barkelew via groups.io wrote:
> Expect a few of these questions as I update 2000+ lines of test code that was written prior to EccCheck.
> 
> “The function headers should follow Doxygen special documentation blocks in section 2.3.5”
> Doxygen doesn’t have a section 2.3.5.
> Nor does the EDKII coding standard.

It probably refers to the syntax that we use for the leading comment
blocks on functions.

"/**" and "**/" for start and finish, @param[in], @param[out], @retval
VALUE, @return, and so on.

https://www.doxygen.nl/manual/commands.html

Thanks
Laszlo