What is a special documentation block?

What is a special documentation block?

[Bret Barkelew]

[-- 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 --]

Re: [edk2-devel] What is a special documentation block?

[Laszlo Ersek]

[-- 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