ebullient / ttrpg-convert-cli

Utility to convert JSON data (for content you own) from 5etools or pf2etools into Obsidian-friendly Markdown.
https://www.ebullient.dev/projects/ttrpg-convert-cli/
Apache License 2.0
149 stars 33 forks source link

Allow unqualified names in Javadoc without making MarkdownDoclet mad #459

Closed miscoined closed 1 month ago

miscoined commented 1 month ago

This is an attempt to allow unqualified names in Javadoc while maintaining the linking and organization of Markdown notes. I've tried to do this in a way that's minimally brittle, and also doesn't balloon out the compile time of these docs.

Currently, it tries all the included packages (dev.ebullient.convert.qute, dev.ebullient.convert.tools.dnd5e.qute and dev.ebullient.convert.tools.pf2e.qute) as the qualified name, and uses it as the qualified name if and only if it's a unique match. This means that only unique class names can be used unqualified, but I can't find a better way of doing this - I can't see any way to access the imports in the file to use that to tell which class is being referenced.

This includes changing some docs to use unqualified names just to test out that it actually works. I've generated the docs locally to test myself of course but I'm on Windows at the moment, so the line breaks and path separators are wrong, which is why I haven't included it.

(This PR is branched off of PR #458 - apologies for the messy diff)