Skia documentation?

[Doc_lover]

Why such complex library that is developed by such big company have no proper documenation. Even examples on skia main page uses deprecated methods. 

[John Stiles]

We use doc-commenting; that is, the public headers should include comments that document the API. For instance:

https://github.com/google/skia/blob/main/include/core/SkCanvas.h#L77-L98

If there is an API which you feel has insufficient docs, please raise specific instances and we'll take a look. 

Outside of that, we also have https://skia.org/docs/ with general documentation—if there are bugs or deprecated calls, let us know at http://skbug.com/ . 

[Joe Gregorio]

On Fri, Aug 25, 2023 at 9:48 AM 'John Stiles' via skia-discuss <skia-d...@googlegroups.com> wrote:

We use doc-commenting; that is, the public headers should include comments that document the API. For instance:

https://github.com/google/skia/blob/main/include/core/SkCanvas.h#L77-L98

If there is an API which you feel has insufficient docs, please raise specific instances and we'll take a look. 

Outside of that, we also have https://skia.org/docs/ with general documentation—if there are bugs or deprecated calls, let us know at http://skbug.com/ . 

Also, all those doc comments show up in the DOxygen documentation: https://api.skia.org/

 

On Friday, August 25, 2023 at 8:55:33 AM UTC-4 Doc_lover wrote:

Why such complex library that is developed by such big company have no proper documenation. Even examples on skia main page uses deprecated methods. 

--
You received this message because you are subscribed to the Google Groups "skia-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to skia-discuss...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/skia-discuss/bb5a4043-fdf5-4ea3-aa19-3aa22939002dn%40googlegroups.com.

[Red Artist]

> If there is an API which you feel has insufficient docs, please raise specific instances and we'll take a look.

I looked at canvas's drawstring/textblob functions, and thought that skia can't do any textlayout stuff at all (as their docs say so). Then, i later find out that there's a textlayout/paragraph/shaper module.

Although, shaper and other text apis do lack docs, the bigger problem is the lack of a high level overview document about skia. The discoverability is too low. https://skia.org website does not advertise skia's capabilities tbh.

(If there is a talk or something that goes over high level skia functionality, i would appreciate a link).

On a side note, what is graphite in the gpu directory. googling gives *zero* helpful references. can someone enlighten me?