Auto generate and deploy API docs from master
pmonks opened this issue · comments
As a prelude to addressing issues #21, #26, #27, and #28, it would be great to autogenerate API docs from the master branch, and publish them on GitHub pages.
Even though those API docs will likely be *cough* "rough" to begin with, by airing our dirty laundry we create pressure on ourselves to fix the docstrings in the codebase.
This is now implemented, but is unfortunately hanging on TravisCI.
I've manually deployed a local build of the docs, so at least there's a starting point for folks evaluating the library, and will temporarily disable doc generation so that the builds on master don't hang then (eventually) time out each time they're run.
I have started to add a small amount of docstrings on my local version, messing with codox to use markdown, etc. Is there any way to generate all the properties that can be used with the controls? I am just finding my way around the api and I do not see anywhere a list of them or a function to produce these.
On a separate, but somewhat related, issue. I did manage to use some fn-fx code to generate a list of all the javafx 11 classes/interfaces and it seems that not all of these are implemented in fx-controls.clj (since I reorganize all the macros it contained into separate alphabetical java package sections). Are there any particular reasons for this? Should these points be filed as new issues?
@laseray that's awesome! I would expect that with some clever use of reflection the properties of each control could be auto-generated, though I haven't explored that myself (at least not with JavaFX - I've done this kind of thing in other Java-interop codebases though).
It's not surprising to me that some of the controls are missing. fn-fx was originally developed for JavaFX bundled with Java 1.8, and it's probable OpenJFX 11 adds some new controls.
As for raising new issues, I personally prefer for any/all issues to be raised so that we can track them (even if no one has time / energy / expertise to fix them right away).
One random thought that your comment prompted - I wonder if it might be possible for the set of JavaFX controls to be discovered automatically by fn-fx? Sadly it doesn't look like there's a suitable JavaFX base class or interface that we could use to dynamically discover all implementing sub-classes, but perhaps there's some way to make the management of the set of controls easier, even if it's not fully automatic? wdyt?