servo / pathfinder

A fast, practical GPU rasterizer for fonts and vector graphics
Apache License 2.0
3.62k stars 207 forks source link

API documentation #162

Open pcwalton opened 5 years ago

pcwalton commented 5 years ago

Sorely needed. Any help is welcome!

toolness commented 5 years ago

Is there a particular aspect of the API you'd like to see documented first?

I was thinking that since the Canvas API is particularly stable, maybe starting with it first would be useful, along with the prerequisites to using it--e.g. Renderer, GLDevice, and FilesystemResourceLoader?

pcwalton commented 5 years ago

Canvas sounds good. I think you can basically copy and paste the MDN documentation: https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D