As part of #14, it seemed like a good idea to generate some usage examples from the code. There is currently a proof of concept of this already working.
I have some more ideas for it:
- Add
@since documentation, either in the Javadoc or in some custom annotation (if there are 2 places they should be synced up somehow)
- Javadoc links to the wiki pages, with e.g. example usage that is syntax highlighted
- Test that any external links in the Javadoc are live (easy for wiki pages, can use relative paths)
- Create a "live links" file, which would be a set of wiki page paths that are supposed to be reachable forever more. The build could append to this list when generating the wiki, but never delete from it
- All links that have moved should have a redirect to the new page, or some blanket page that explains why the link was broken
- Create a "redirect.properties" file that maps old paths to new paths. This could be used during the wiki generation to populate the redirects, complaining if there is a "live links" file entry that has neither a page nor a redirect
As part of #14, it seemed like a good idea to generate some usage examples from the code. There is currently a proof of concept of this already working.
I have some more ideas for it:
@sincedocumentation, either in the Javadoc or in some custom annotation (if there are 2 places they should be synced up somehow)