search

schultek / jaspr

Modern web framework for building websites in Dart. Supports SPAs and SSR.
https://jasprpad.schultek.de
MIT License
996 stars 59 forks source link

Add documentation comments for public classes and methods #233

Open suragch opened 2 months ago

suragch commented 2 months ago

Description

The website documentation is pretty good. It would also be helpful to have documentation comments for the various public classes and methods in Jaspr. It appears that currently none of the code has doc comments.

Additional Context

I'm familiar with Flutter but not so much with CSS. A lot of the syntax follows HTML and CSS naming conventions, but for someone not familiar with these things, it's a little difficult to understand how styling and other aspects work when reading and exploring the code. For example, what is a flexbox or rem or div or section? I'm sure they make sense to someone from a web dev background but not so much for a Flutter dev. And if I had a web dev background in the first place, I probably wouldn't need to use Jaspr.

If I continue using Jaspr, I might be willing to add documentation comments as I learn what things do. Are you open to PRs for that?

schultek commented 2 months ago

Yes code docs are behind big time 🙈 These really need some love.

PRs would be awesome!

suragch commented 2 months ago

Sorry, I was wrong about none of code having doc comments. I had missed it earlier by not scrolling down far enough in VS Code's documentation preview. However, I did submit PR #234 to add comments for the CSS units that had previously confused me.