icepkg icon indicating copy to clipboard operation
icepkg copied to clipboard

求支持 文档对函数签名的细化

Open JinYi2000 opened this issue 1 year ago • 0 comments

有一些字段被@ice/remark-react-docgen-docusaurus识别为了signature。 例如:onChange?: (result: string) => void;的类型被识别为了signature。 想直接在文档中展示onChange的类型为(result: string) => void; image image

JinYi2000 avatar Dec 19 '23 06:12 JinYi2000

The issue with truncated fixed length types such as uint16_t, uint8_t... is that, depending on processor architecture, using them in local variables or function parameters (where registers will typically be used) will force the compiler to emit masking instructions.

So they really should only be used in struct to reduce memory size, or if there is an imperative to limit the value and the masking is necessary. Otherwise, we should use the uint_fast16_t, uint_fast8_t...

If we go this route, then I suggest this issue should be included in a more broader scope issue.

jean-roland avatar Dec 27 '23 09:12 jean-roland

uint_fast_*_t or uint_least*_t were in the backlog to be considered, but there was a first check on how does it impact the MISRA-C compliance.

This check is still pending and, in my opinion, it shall be done before moving into those types.

cguimaraes avatar Dec 28 '23 10:12 cguimaraes