Uploaded image for project: 'Aptana Studio'
  1. Aptana Studio
  2. APSTUD-3533

Add URL to SDOCML/JSCA file format, indicating the documentation location for a particular function/method/class

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Low
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Content Assist, JS
    • Labels:

      Description

      When pressing F3 on a function, we should take the user to the source declaration. However, for built-in functions, that's not so easy. Where do we take them? The SDOCML file? That's not very intuitive.

      Suggest adding a URL parameter (could even be called a permalink, perhaps), that would be URL to fetch if we were called on to display information in this context. It could be a local URL or a remote one.

      As a shortcut, a JSCA file or SDOCML file could also define some sort of regex that applied to the whole document...i.e. if the documentation files were constructed off some regular pattern from the function/method names, a single root-level element might describe how to construct a URL autoamtically.

      The documentation should probably open up much as help does, in an editor window

        Attachments

          Activity

            People

            • Assignee:
              pinnamuri Praveen Innamuri (Inactive)
              Reporter:
              ingo Ingo Muschenetz
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:

                Git Source Code