org.das2.jythoncompletion.JavadocLookup

Provide a class for keeping track of the Javadoc lookups, so this is not buried in code (so much).

JavadocLookup( )

getInstance

getInstance( ) → JavadocLookup

get the one instance

Returns:

the instance

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getLinkForJavaSignature

getLinkForJavaSignature( String signature ) → String

return a link to the documentation for a java signature. For standard library things, this goes to Oracle's website. For other things, this goes to the Autoplot/Das2 javadocs. Java8 http://docs.oracle.com/javase/8/docs/api/java/io/File.html#createTempFile-java.lang.String-java.lang.String-java.io.File-

Parameters

signature - signature like javax.swing.JCheckBox#paramString()

Returns:

null or the link, like http://docs.oracle.com/javase/6/docs/api/javax/swing/JCheckBox#paramString() TODO: it appears that this needs /x/y/z.html!

[search for examples] [view on GitHub] [view on old javadoc] [view source]

searchForSignature

searchForSignature( String clas ) → List

given a class name, what are fully-qualified class names which match?

Parameters

clas - a String

Returns:

a java.util.List

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setLinkForJavaSignature

setLinkForJavaSignature( String signatureStart, String link ) → void

add the location of the javadocs for the given path. The path should be / separated, not period separated.

Parameters

signatureStart - e.g. "gov/nasa/gsfc/spdf/cdfj"
link - e.g. "https://cdaweb.sci.gsfc.nasa.gov/~nand/cdfj/docs/"

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]