public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Bret Barkelew" <bret.barkelew@microsoft.com>
To: "devel@edk2.groups.io" <devel@edk2.groups.io>
Subject: What is a special documentation block?
Date: Fri, 25 Sep 2020 01:16:59 +0000	[thread overview]
Message-ID: <MW4PR21MB185777124D141CA5FA693619EF360@MW4PR21MB1857.namprd21.prod.outlook.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 288 bytes --]

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.

- Bret


[-- Attachment #2: Type: text/html, Size: 1640 bytes --]

             reply	other threads:[~2020-09-25  1:17 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-25  1:16 Bret Barkelew [this message]
2020-09-25  7:57 ` [edk2-devel] What is a special documentation block? Laszlo Ersek

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=MW4PR21MB185777124D141CA5FA693619EF360@MW4PR21MB1857.namprd21.prod.outlook.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