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 libcosmic docs (?) #602

Open
elevenhsoft opened this issue Sep 7, 2024 · 3 comments
Open

Improve libcosmic docs (?) #602

elevenhsoft opened this issue Sep 7, 2024 · 3 comments

Comments

@elevenhsoft
Copy link
Contributor

Hello,

Right now we have docs located there: https://pop-os.github.io/libcosmic/cosmic/index.html and it's fine (except slow searching ;)). I'm not familiar with generating documentation, but I see there is for example no info about applet, which is hidden by feature. Is it possible to improve this docs, and include variables and functions from features (i guess that's the issue). I was looking for applets, and there is no info about it. Also if we look into Core for example, we see in source there is public field applet hidden by feature, so on the main page it's not showing in public fields, but it says the rest are private.

@mmstick
Copy link
Member

mmstick commented Sep 7, 2024

They're automatically generated from code comments above functions and types; and at the top of modules; with cargo doc.

@elevenhsoft
Copy link
Contributor Author

Yeah I was not sure since I never used it 😅 On docs.rs we have some more info, about features etc so I though it's something missing.

So we should use source code probably in this case.

@wiiznokes
Copy link
Contributor

Unfortunately, winit and applet features are not additive, so we can't call cargo doc --no-deps --all-features. A solution for this could be to add another crates specific to applets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants