search

dnault / therapi-runtime-javadoc

Read Javadoc comments at run time.
Apache License 2.0
117 stars 19 forks source link

Issue20/add import resolver #46

Closed kirkch closed 3 years ago

kirkch commented 3 years ago

This is a fairly large PR. To review, I suggest breaking it down into the following parts:

  1. addition of a new module for acceptance tests; only two tests at the moment that demonstrate this change.
  2. changes to scribe that adds imports to the output json.
  3. addition of ClassResolver (read in isolation using ClassResolverTest as a guide)
  4. and lastly, wiring the ClassResolver into the runtime javadoc parser

Please note that this PR's branches from branch #21, please review and merge that branch first. I did this so that this change would resolve @throws and @exception tags as well as @see.

Resolves #20.

dnault commented 3 years ago

Hi Chris, thanks for this. Can you help me understand why the class resolution happens at runtime instead of at compile time?

joffrey-bion commented 3 years ago

Hi Chris, thanks for this. Can you help me understand why the class resolution happens at runtime instead of at compile time?

I was about to comment the same thing. I wonder why we don't just resolve the class names with respect to the imports at compile time, to provide the fully qualified class names in the JSON then. I think the notion of imports shouldn't make it to the JSON representation of the Javadoc.

kirkch commented 3 years ago

Can you help me understand why the class resolution happens at runtime instead of at compile time?

I agree that having it done at the time of generating the json would be preferable. I flagged this before I started when I mentioned writing the imports to the json file. joffrey is right that not having them in there at all is preferable. At this stage, given how long the ticket has stood open, I would argue that a runtime resolver is preferable over having no resolver and this ticket remaining stagnant. Once we have how to resolve within the javac api licked, then the runtime resolver can be pulled. Or if this PR inspires somebody to write that now, that would be great.