search

INRIA / spoon

Spoon is a metaprogramming library to analyze and transform Java source code. :spoon: is made with :heart:, :beers: and :sparkles:. It parses source files to build a well-designed AST with powerful analysis and transformation API.
http://spoon.gforge.inria.fr/
Other
1.74k stars 346 forks source link

good first issue: add documentation for 3 undocumented public methods #1876

Open monperrus opened 6 years ago

monperrus commented 6 years ago

In Spoon, we want that all public methods are properly documented.

We have a test case to check this: https://github.com/INRIA/spoon/blob/51c4b2211922e71914f74ce4341a6232c079f174/src/test/java/spoon/test/architecture/SpoonArchitectureEnforcerTest.java#L120

This test case temporarily skips small methods.

To get this issue done:

ZhectorSM commented 4 years ago

Hi guys, I'm new in the open-source world, so I'll try to help you with some issues starting with this one.

monperrus commented 4 years ago

Excellent, welcome @ZhectorSM!!

ZhectorSM commented 4 years ago

doc: add API documentation to public methods PR #3152

slarse commented 3 years ago

Also see #3923 regarding the quality of the Javadoc!

TheMarvelFan commented 11 months ago

Is this issue still open?

MartinWitt commented 11 months ago

Yes, feel free to start working on it

TheMarvelFan commented 11 months ago

@MartinWitt @slarse @monperrus @ZhectorSM Can someone please review PR #5490 It would mean a lot to me if someone can provide feedback on this.

TheMarvelFan commented 10 months ago

Hi has anyone looked at PR #5490 yet?