I’m writing the initialization code for a module. Finding the class in the SDK javadocs is not a simple matter. Where, for example, would one expect to find SRConnection?
(Aside: I had to find the path to SRConnection in order to import the class, even if I had no interest in the documentation itself. The only way I know to discover the path is to look in the javadocs tree.)
After poking around in the javadocs index without success, I resorted to a grep search of the javadocs folder. It takes about a minute to search the folder tree the first time. There are 27 html files that contain the string SRConnection. Near the end of the list I saw SRConnection.html. So the whole exercise took several minutes, including poke-around time. Not good.
Is there a better way to find classes in the javadocs?
I also need documentation for the DBTableSchema class. Same thing–spend a minute or two looking though the index, give up and run grep. In this case, DBTableSchema.html is an orphan. DBTableSchema does not appear in the class list on the page for com.inductiveautomation.ignition.common.db.schema. I had to drill down to the subfolder in File Explorer and double-click on DBTableSchema.html to open the document page.