Request Description
.uni files are written to the EDK II Multi-String .UNI File Format Specification.
It is common to use // for header comments since that is the valid comment format for .uni files. Many files place /** directly inside those line comments. For example:
// /** @file
// Based on files under Nt32Pkg/MiscSubClassPlatformDxe/
//
// Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>
// Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
// Copyright (c) 2015, Hisilicon Limited. All rights reserved.<BR>
// Copyright (c) 2015, Linaro Limited. All rights reserved.<BR>
// SPDX-License-Identifier: BSD-2-Clause-Patent
//
// **/
The first part of this issue is to clarify why this is done. And, if not already documented somewhere, document why in a relevant location (if the /** format is deemed the best long-term approach).
It is suspected that this is only done because /** is comment block style (Javadoc style) recognized by Doxygen.
If it is indeed only done for Doxygen, then a more natural style that does not mix comment block types given the // requirement would be /// as described in doxygen: Comment blocks for C-like languages.
If that is confirmed as acceptable for this use case, then the task tracks updating UNI file headers to use that style.
Are you going to make the change?
Someone else needs to make the change
Do you need maintainer feedback?
Maintainer feedback requested
Anything else?
No response
Request Description
.uni files are written to the EDK II Multi-String .UNI File Format Specification.
It is common to use
//for header comments since that is the valid comment format for .uni files. Many files place/**directly inside those line comments. For example:The first part of this issue is to clarify why this is done. And, if not already documented somewhere, document why in a relevant location (if the
/**format is deemed the best long-term approach).It is suspected that this is only done because
/**is comment block style (Javadoc style) recognized by Doxygen.If it is indeed only done for Doxygen, then a more natural style that does not mix comment block types given the
//requirement would be///as described in doxygen: Comment blocks for C-like languages.If that is confirmed as acceptable for this use case, then the task tracks updating UNI file headers to use that style.
Are you going to make the change?
Someone else needs to make the change
Do you need maintainer feedback?
Maintainer feedback requested
Anything else?
No response