On 4/21/23 08:59, Marcin Juszkiewicz wrote:
Thanks for links. Interface for EDK2 CI is not easy for beginners.
It really isn't, unfortunately.
Doxygen info is something I probably never wrote so would need to look
at rest of EDK2 code to find out what it is and how to use it.
It's pretty straightforward. The format EDK2 uses is:
/** Description of the function.
@param FirstParam Description of FirstParam:
Can use multiple lines.
@param SecondParam Description of SecondParam.
@return Explanation of return values - or can use @retval instead.
@retval FirstPossibleReturnValue Can use @retval instead of @return
to describe individual values.
@retval SecondPossibleReturnValue Description.
**/
There is also this:
> ERROR - EFI coding style error
> ERROR - *Error code: 9001
> ERROR - *The file headers should follow Doxygen special
> documentation blocks in section 2.3.5
> ERROR - *file: D:\a\1\s\Build\.pytool\Plugin\EccCheck\ArmPkg
> \Application\ArmCpuInfo\ArmCpuInfo.inf
> ERROR - *Line number: 1
> ERROR - *Header comment section must have Abstract information.
Same situation as with Doxygen above.
Oh, that's something I've had trouble with in the past. For your patch,
it's probably due to the blank line between @file and the description:
## @file
#
# Attempt to have AArch64 cpu information.
One more thing: copyright lines should ideally have "<BR>" at the end,
to indicate to Doxygen to add a line break.
--
Rebecca Cran
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#103405): https://edk2.groups.io/g/devel/message/103405
Mute This Topic: https://groups.io/mt/98390298/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
