Uploaded image for project: 'Scripting Documentation Application'
  1. Scripting Documentation Application
  2. SCRIPTDOC-4

Add support for retrieving documentation for any loadable Java class

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.0
    • Fix Version/s: 1.1
    • Component/s: API, UI
    • Labels:
      None
    • Similar issues:

      Description

      Introduce a new simplified finder component:

      public interface TypeInformationFinder
      {
          /**
           * @param type a java type.
           * @return information and documentation about the given type, or null if not found.
           */
          Binding find(Type type);
      
          /**
           * @param name a type name.
           * @return information and documentation about the given type, or null if not found.
           */
          Binding find(String name);
      }
      

      and a scripting service method to use it:

          /**
           * Return information about a Java type.
           * @param name the fully qualified name of the desired class.
           * @return a binding providing information about the given class or null if not found.
           */
          public Binding getTypeInformation(String name) {
              return typeInformationFinder.find(name);
          }
      

      Finally, use the above to provide dynamically some missing links for the xwiki classes in the Javadoc, for example when the link is crossing project, for example between platform, rendering and commons.

        Attachments

          Activity

            People

            • Assignee:
              softec Denis Gervalle
              Reporter:
              softec Denis Gervalle
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: