Class DocNames


  • public class DocNames
    extends java.lang.Object
    Static methods to give the locations of run-time javadocs. This class provides a central repository for knowledge about the naming of the files/resources which contain the javadoc information needed at runtime (classes accessible within JEL).
    Since:
    2 Sep 2004
    Author:
    Mark Taylor (Starlink)
    • Constructor Summary

      Constructors 
      Constructor Description
      DocNames()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.net.URL docURL​(java.lang.Object obj)
      Returns the URL which points to the documentation object for a given object, or null if none can be found.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DocNames

        public DocNames()
    • Method Detail

      • docURL

        public static java.net.URL docURL​(java.lang.Object obj)
        Returns the URL which points to the documentation object for a given object, or null if none can be found. Currently, Classes, Fields, Methods and Headings are known about.
        Parameters:
        obj - object to be documented
        Returns:
        URL of doc file (probably HTML)