From: "Laszlo Ersek" <lersek@redhat.com>
To: devel@edk2.groups.io, bret.barkelew@microsoft.com
Subject: Re: [edk2-devel] What is a special documentation block?
Date: Fri, 25 Sep 2020 09:57:43 +0200 [thread overview]
Message-ID: <a4ee2bc6-2b57-2e2c-89f7-11759b900a28@redhat.com> (raw)
In-Reply-To: <MW4PR21MB185777124D141CA5FA693619EF360@MW4PR21MB1857.namprd21.prod.outlook.com>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=windows-1252, Size: 592 bytes --]
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
prev parent reply other threads:[~2020-09-25 7:57 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 1:16 What is a special documentation block? Bret Barkelew
2020-09-25 7:57 ` Laszlo Ersek [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a4ee2bc6-2b57-2e2c-89f7-11759b900a28@redhat.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox