Add missing documentation

[kisvegabor]

Introduce the problem

Some new features are not documented properly.

• Gradients
• Vector fonts
• Vector API
• ThorVG
• Caching
• SW rendering
• Styles
  • Color filter
  • Gradients
• Chip vendors
  • ST
  • NXP
  • ESP See Update our ESP docs #6574
• RTOS
  • FreeRTOS

Proposal

No response

[vwheeler63]

@kisvegabor

Hi, Gabor! I can help with this. Esp. the FreeRTOS part. There is a lot more in the list as well. We can use at least part of the (upcoming) Doxygen "is not documented" baseline list to help.

As an aside, I also note that the documentation about threading is incomplete. I have taken some notes about this, as I had to deal with it extensively in a project that was handed over to me in early 2022 that had LVGL calls being made from 6 different threads! I think I can do a good job of supplementing that documentation. I think there will be a lot more too. Let me know your thoughts.

[kisvegabor]

Hi Vic,

It would be amazing!

Regarding ESP, I've opened an issue earlier: #6574 Espressif is an important partner of LVGL, so if you are interested in it, it would be great to start with it.

[kisvegabor]

I've just noticed that @tore-espressif already sent a PR to update the ESP docs: #6658

[vwheeler63]

Hi, Gabor!

I'm sorry, I created a misunderstanding: I should be more careful about abbreviating. By "Esp." I meant "especially" -- especially FreeRTOS.

I do keep hearing however about the ESP32 -- it must be a popular microcontroller. I am guessing it is going to be in my future.... Minus actual knowledge of the ESP32, I gave their PR a review as the document content and web linked looked good from the perspective of grammar and web links being valid. What a nice partnership with LVGL!! I hope it's proving profitable!

I am an expert, however, with the PIC32MX and PIC32MZ. :-)

[clydebarrow]

Another undocumented (old) feature - color filters. And color gradients.

[kisvegabor]

@vwheeler63
FreeRTOS only is awesome too 😊

Microchip is not an official partner of LVGL yet and we don't have in house expertise for PICs now. It might be a good collaboration/work opportunity in the future!

@clydebarrow

Another undocumented (old) feature - color filters. And color gradients.

Added to the list, thank you!

[vwheeler63]

It might be a good collaboration/work opportunity in the future!

I like the sound of that. :-)

[lorenzo-arena]

About "Color filter" and "Gradients": what would be a good place for them? I see that there's already a section with a "TODO" for Color filter, would it be good to add gradients right after that?

[vwheeler63]

About "Color filter" and "Gradients": what would be a good place for them? I see that there's already a section with a "TODO" for Color filter, would it be good to add gradients right after that?

Seems logical.