Menu
▾
▴
#2397 shortcomings of new javadoc generation
About a year ago there was an effort to make a version of the JavaDoc which could be put onto a github site so that many people could maintain it. There are shortcomings I notice as I'm going through and reviewing this output. This ticket will enumerate.
Discussion
Single quotes, like "reduce the dataset's rank" cause the summary to break at the quote. See http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/index-all.html, reduceMax.
expm1's
breaks the line.
Last edit: Jeremy Faden 2021-10-07
Often if there's an undocumented f(Object) and f(QDataSet) no documentation is used. I can't recall how it decides which signature to show, but this should be revisited. See stddev(O)
Last edit: Jeremy Faden 2021-10-07
Many of the functions result in no javadoc.
See https://github.com/jbfaden/MarkdownDoclet , which is the project where this is implemented.
See also https://sourceforge.net/p/autoplot/bugs/2353/
Sadie didn't like how multiple var-args functions were coalesced. For example, findgen(int) and findgen(int,int) would show the same documentation. This was confusing for things like fftPower where the different modes were not shown.
I've made it so this no longer happens, but the javadocs will be inconsistent when Autoplot version v2025a_3 or earlier is used.