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

Widget documentation #15

Closed
elkowar opened this issue Oct 14, 2020 · 1 comment
Closed

Widget documentation #15

elkowar opened this issue Oct 14, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@elkowar
Copy link
Owner

elkowar commented Oct 14, 2020

All provided widgets need complete documentation. This should be automatically generated from comments in the source code

Acceptance criteria

  • A strict format for the comments that document built-in widgets is designed
    • Links to the GTK-documentation of these widgets is provided if applicable
    • Attributes are documented, including type / all possible values where applicable
    • a description of the widget is included
    • a instanceof referencing-system is implemented which allows widget docs to link to all super-classes, automatically including the super-classes docs in the widget docs.
  • A script that generates markdown documentation from these comments is implemented
  • All built-in widgets are fully documented using the created format
@elkowar elkowar added the documentation Improvements or additions to documentation label Oct 14, 2020
@elkowar elkowar self-assigned this Oct 14, 2020
@elkowar
Copy link
Owner Author

elkowar commented Oct 25, 2020

Widget documentation as well as the docs created in #17 is now available at https://elkowar.github.io/eww/main/ 🥳

@elkowar elkowar closed this as completed Oct 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant