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

JavaDoc documentation #362

Open
Clijsters opened this issue Nov 23, 2017 · 0 comments
Open

JavaDoc documentation #362

Clijsters opened this issue Nov 23, 2017 · 0 comments

Comments

@Clijsters
Copy link

Hey Guys...

The lack of documentation (especially in code, accessible one) is outstanding for this project. Most times I walk through the internet searching for jtwig related stuff, I see people moan about the incomplete documentation.

The only documentation I can find are these reference documentations, from which 50% are currently unavailable:

There doesn't seem to be any JavaDoc documentation in the code, especially the Spring part is quite hard to use with only the getting started guides provided. I would really like to see some docs on how to override Renderers, ViewResolvers, how to configure them, add functions, ...

As of now, I have to dig through the code, penetrate google with thousands of queries, going to several Getting Started guides though I don't want to get started, but have questions regarding specific implementations.

Are there any plans to extend the current documentation? Can one submit PRs with added JavaDoc comments?

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

1 participant