pippo icon indicating copy to clipboard operation
pippo copied to clipboard

Improve / Add javadoc

Open mmadson opened this issue 8 years ago • 6 comments

For example, I'd like to use my IDE to bring up the javadoc for the ALL() method on Application and have it explain what ALL actually means. Instead, I needed to dig into the code before I realized that ALL meant the route applied to all http methods.

mmadson avatar May 09 '16 10:05 mmadson

Sure. The javadoc (and the unit tests) must be improved. My time (for the moment) on open source projects is a bit limited so I would be grateful if anyone can help in this direction.

decebals avatar May 09 '16 12:05 decebals

Apologies for being soo terse, I was in a bit of a rush but I wanted to make sure I could track the issue. Pippo looks very promising. I've evaluated it as well as Spark and I'm far more impressed with Pippo's parameter handling than Spark's so I hope Pippo will take off. That said, I think Javadoc is important for ensuring broader adoption. If I'm able find some free time to help out, I'll surely submit some pull requests adding javadoc.

All the best!

mmadson avatar May 09 '16 18:05 mmadson

Apologies for being soo terse, I was in a bit of a rush but I wanted to make sure I could track the issue.

No problem. I understand you.

Pippo looks very promising. I've evaluated it as well as Spark and I'm far more impressed with Pippo's parameter handling than Spark's so I hope Pippo will take off.

Thanks. Pippo has many nice features (unfortunately some of which are incompletely documented or undocumented), it's a mature framework but not so popular as Spark.

That said, I think Javadoc is important for ensuring broader adoption. If I'm able find some free time to help out, I'll surely submit some pull requests adding javadoc.

Yes, I'm aware about the importance of Javadoc and I will try to improve that component. Time is my main opponent.

decebals avatar May 09 '16 19:05 decebals

Hi, any updates on this?

Shujito avatar Apr 05 '18 18:04 Shujito

I always try to improve the javadoc when I commit. I think that now is better but there is always room for better. Javadoc + documentation site + documentation from each major PR are good sources of information. If you see some aspects that are not enough documented please let me know. Any contribution related to this subject is very welcome.

decebals avatar Apr 05 '18 19:04 decebals

I added more content to the documentation site. If you see some aspects that are not described please let me know. They are some topics on the todo list.

decebals avatar Jul 10 '18 13:07 decebals