Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve cairo documentation #1194

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Conversation

ElectrifyPro
Copy link

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
Member

That looks like a good start! thanks a lot

#[derive(Clone, PartialEq, Eq, PartialOrd, Debug, Copy)]
#[non_exhaustive]
#[doc(alias = "cairo_antialias_t")]
pub enum Antialias {
/// Use the default antialiasing for the subsystem and target device.
Copy link
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
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
Member

Any chance for pushing this forward? :)

@ElectrifyPro
Copy link
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