Skip to content

Improve cairo documentation#1194

Draft
ElectrifyPro wants to merge 9 commits into
gtk-rs:mainfrom
ElectrifyPro:cairo-doc
Draft

Improve cairo documentation#1194
ElectrifyPro wants to merge 9 commits into
gtk-rs:mainfrom
ElectrifyPro:cairo-doc

Conversation

@ElectrifyPro

Copy link
Copy Markdown

This is a project to add documentation to all of cairo's public types. I'm pulling most of the documentation from the C reference, and adding examples where needed.

Closes #1187.

@bilelmoussaoui

Copy link
Copy Markdown
Member

That looks like a good start! thanks a lot

Comment thread cairo/src/enums.rs
Comment thread cairo/src/enums.rs
#[non_exhaustive]
#[doc(alias = "cairo_antialias_t")]
pub enum Antialias {
/// Use the default antialiasing for the subsystem and target device.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add Default impls on enums that have "Default" variants like this one?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

possibly yes, as a separate commit please :)

@bilelmoussaoui

Copy link
Copy Markdown
Member

Any chance for pushing this forward? :)

@ElectrifyPro

Copy link
Copy Markdown
Author

Yes! I put this aside a long time ago and forgot to come back. I'm happy to keep working on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE REQUEST] Improved documentation for cairo

2 participants