CubeMX add comment/remark/note (comments/remarks/notes)

[Syn_BE]

Hi there,

is there a possibility in CubeMX to add a remark/comment/note to a peripheral or its configuration?

Background:

• I would like to leave a note (in CubeMX) about what I use Timer5 for and why I configured it that way

 

[Mahmoud Ben Romdhane]

Hello @Syn_BE 

First let me thank you for posting.

It is not possible to add comments and notes to the device used in Cube Mx.

I recommend you take into consideration that you are able to notice the description, the summary and the documentation of each peripheral when you move the mouse cursor over the name. 

 

[Syn_BE]

Dear Mahmoud,

thanks for your answer. Yes, I know the possibility to see "summary, etc" by "mouse over". And that's really a good feature.

But the big advantage of writing own comments would be "documentation for others": You could tell other project-people what you use the timer (the peripheral) for and why you had to configure it that way.

Maybe this would be a useful feature request?

[Pavel A.]

See this:

https://community.st.com/t5/stm32cubeide-mcu/explanation-field-to-cubeide/td-p/576362

[Syn_BE]

Dear Pavel,

good link! Thanks a lot. I will add my feature requests there.