From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from NAM10-BN7-obe.outbound.protection.outlook.com (NAM10-BN7-obe.outbound.protection.outlook.com [40.107.92.113]) by mx.groups.io with SMTP id smtpd.web12.4624.1600996622389433522 for ; Thu, 24 Sep 2020 18:17:03 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@microsoft.com header.s=selector2 header.b=Kea7BA5E; spf=pass (domain: microsoft.com, ip: 40.107.92.113, mailfrom: bret.barkelew@microsoft.com) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ioqb6SC2yRD9IbZscEEoW+VkzZHouBlHZaUaGcBKw/pwMAWtxqVsrLJHzHXhGzs3f4YwVrDYb9XUmwkf7xhPLcWrShqN8g1EipwLC53Ae5n+XnIxfHX3/EDH7r+1Ov9VkHh/kRpbcJwwjc6ECTwsPSpFn+0SEKpyTmAYVqyz2cKmUYn7MMVb8EjpNw+7+fJczWx9LmTkFcns4YYgtBWqsu/R5uGmQY3SQP8LVBi1i+Z6YROY19eQfvjR42iaLQEhy0Hx43ppmjpED9RXEM8iMJ/PAgUfEzoqcxqPH9DJQu/zdJ7aV1pIZLuG8thlpdylOrw2ZMTYSMW7Y6swhP4nlQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=JlWjP/5/wpxN1wS5o+Thz8Yrze0o2Bp2UpVwWa/KvCU=; b=oQr00Lu1/X0JiyvqMQ2oFEm+YXh+ZKg/kyzBu6g7l5Prm6Egltxu2bdoN6XqsndUB8sv2LEMaJcWldM9LPDejIkbum99isBM+TPG7NqVs1g/uvdhRESGUQSbf2EBXSK8xJbjSyT7e5B+/WHCiDUP3lmGTTiV7q2Q7s6pvfEIQ11ZD09n18jV9z7Ic1IHMddg7zPts73g2OrMTdwbNf+YyJjeiweXgt2o1a8J0MBdOVRDP82xRnB7yHaZgDjJj1uibk90GxKAJfWNEXiztxVe9b/ahxlkrZUR09hR7j2ypWqHC6W9skWDh+5eM9zw5e/BfL5ZVHag2WrkXPDC68aJmA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=microsoft.com; dmarc=pass action=none header.from=microsoft.com; dkim=pass header.d=microsoft.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=JlWjP/5/wpxN1wS5o+Thz8Yrze0o2Bp2UpVwWa/KvCU=; b=Kea7BA5E4Bw5tASkUtIAb58pW9VjtnEMz3qrNA2jh8ZPFIQ+V1N0ijKplNAwAMYc6BJkcXVMnQ3+VLcvEh4SVI6QGybx9an/TgYQc9tw8nLRBY//rYka/SIBYfbl+/uwHAKITXLTOc//xhUEAjB1WW1aqDj8XQ9VJdtDABndQWU= Received: from MW4PR21MB1857.namprd21.prod.outlook.com (2603:10b6:303:74::12) by MW2PR2101MB1834.namprd21.prod.outlook.com (2603:10b6:302:7::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3412.1; Fri, 25 Sep 2020 01:17:00 +0000 Received: from MW4PR21MB1857.namprd21.prod.outlook.com ([fe80::2967:7434:51bb:e234]) by MW4PR21MB1857.namprd21.prod.outlook.com ([fe80::2967:7434:51bb:e234%4]) with mapi id 15.20.3433.018; Fri, 25 Sep 2020 01:17:00 +0000 From: "Bret Barkelew" To: "devel@edk2.groups.io" Subject: What is a special documentation block? Thread-Topic: What is a special documentation block? Thread-Index: AQHWktlq7v8ZN9XYvEWUZQU2D9sKXQ== Date: Fri, 25 Sep 2020 01:16:59 +0000 Message-ID: Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: msip_labels: MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Enabled=True;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SiteId=72f988bf-86f1-41af-91ab-2d7cd011db47;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_SetDate=2020-09-25T01:15:53.8114430Z;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_ContentBits=0;MSIP_Label_f42aa342-8706-4288-bd11-ebb85995028c_Method=Privileged authentication-results: edk2.groups.io; dkim=none (message not signed) header.d=none;edk2.groups.io; dmarc=none action=none header.from=microsoft.com; x-originating-ip: [174.21.140.128] x-ms-publictraffictype: Email x-ms-office365-filtering-ht: Tenant x-ms-office365-filtering-correlation-id: a6aec378-d026-4985-52da-08d860f0b3f8 x-ms-traffictypediagnostic: MW2PR2101MB1834: x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:6108; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: E75ew+Ajp9YKa6mUFaLD19vUp6IShF0E3/tC/RKIS77SqvLRcLBHaScVS4HYfGsvhbtHx2glMZHhTgjx740OVSG/d1XNFkFDTrn/YLN3H7LCi2B6hCRj0npHqYYQTTO8wFNKbESZs49EErP45wki5oB+ILt5QVdMZ4/7/WRk1vwf2ZcBYw+G3J8cSenQQFp0wu49QmDD2kDcSipyS6SiYOp3HV8Wfe+YOgSI61TWtbZ/rDpuWqrq208agJjGSp0NZS0p1CgFCJzHTTnI07yKiCRIC6Y5drSf65vOS3zrJZKCGHcJLi6ww5YXhcJbaCveJs9tCF7QcNPx9Rwkcf735VMhIDO8wvgbEuSaitlLqotjpkxpyS9ct4k1gOt44v/q x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:MW4PR21MB1857.namprd21.prod.outlook.com;PTR:;CAT:NONE;SFS:(4636009)(366004)(396003)(136003)(39860400002)(346002)(376002)(66946007)(10290500003)(6916009)(8936002)(82950400001)(478600001)(52536014)(82960400001)(9686003)(5660300002)(2906002)(83380400001)(8990500004)(8676002)(55016002)(558084003)(316002)(86362001)(66556008)(71200400001)(6506007)(26005)(7696005)(66446008)(186003)(76116006)(33656002)(66476007)(64756008);DIR:OUT;SFP:1102; x-ms-exchange-antispam-messagedata: sk5YWIpyWv4QibI/eLYbfoaf1T6NuM1c0qorYXUlGpprzImPYWvgZ6tCw2l9+5EjjjnRbHuKly74Wibo9YWNU0KjX328+7i7xqlrQUolCbHIRgXa2x9vobRtwsIbeV+8Yw0lrSEyr/kqQyZqRihjGpC8lJYoRpmVF1b2x+JHEIeGBP4D10mlGXTm+28cSwxi8HEp9rSpJB1yN5YiAW//Kw9hxrHOXExFlCLpKibvI3DUXqAFQkKkymuL3fb5xmwJp3F9EFiDVz0G8WKc8MP64CPhkXeMxtdjdZ9nopXO2sz88xXeJZ2ignmq7WlGIo94FJ+SkrJEeaFzVUQAYuuQVYF8dFN7qQ7t0A3aSVeaSnjakbA0Yptqc5D+rkOTrpu+4dNQweK+j/4HnwiVsM7pRQc9A2YVvI6RYGmEl3p2OTNxWt76qRit0pQt1JQQcHvIGgToLoUlaH1SuDHOJdRS+kr/1g0xvLSJp1+HFjTg14NSZb6yKfCg6kW44Exfa56ay5ayucLcKDWV98kSVzps3n+G+Mh3cDksXfwqMt6QgC9Te/NmcGKRmhKF6RQK26IACg7GYk5Gg46Yq+Y12aQaEbkFbPvNRNuDS6k0TCquwdJQI6LWcdl3crbViqhtfhuOIi/IKdwOKEbh5g64Nmf3bg== x-ms-exchange-transport-forked: True MIME-Version: 1.0 X-OriginatorOrg: microsoft.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: MW4PR21MB1857.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: a6aec378-d026-4985-52da-08d860f0b3f8 X-MS-Exchange-CrossTenant-originalarrivaltime: 25 Sep 2020 01:16:59.9404 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 72f988bf-86f1-41af-91ab-2d7cd011db47 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: ubj26CIZ7F4xiYH2WXuyFjyMT76XJ0BIEOJljxHIwt74vsYh32oO/2jqu99qnV+UBAjLYxWC9VfbA+bfGLvXgg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW2PR2101MB1834 Content-Language: en-US Content-Type: multipart/alternative; boundary="_000_MW4PR21MB185777124D141CA5FA693619EF360MW4PR21MB1857namp_" --_000_MW4PR21MB185777124D141CA5FA693619EF360MW4PR21MB1857namp_ Content-Type: text/plain; charset="Windows-1252" Content-Transfer-Encoding: quoted-printable Expect a few of these questions as I update 2000+ lines of test code that w= as written prior to EccCheck. =93The function headers should follow Doxygen special documentation blocks = in section 2.3.5=94 Doxygen doesn=92t have a section 2.3.5. Nor does the EDKII coding standard. - Bret --_000_MW4PR21MB185777124D141CA5FA693619EF360MW4PR21MB1857namp_ Content-Type: text/html; charset="Windows-1252" Content-Transfer-Encoding: quoted-printable

Expect a few of these questions as I update 2000+ li= nes of test code that was written prior to EccCheck.

 

=93The function headers should follow Doxygen specia= l documentation blocks in section 2.3.5=94

Doxygen doesn=92t have a section 2.3.5.

Nor does the EDKII coding standard.

 

- Bret

 

--_000_MW4PR21MB185777124D141CA5FA693619EF360MW4PR21MB1857namp_--