Uploaded image for project: 'Jahia Community'
  1. Jahia Community
  2. JAHIA-4270

Move JavaDoc documentation to taglibs

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Minor
    • xCM 6.0.0
    • xCM 6.0
    • None

    Description

      Why are we documenting the tags and its attributes in the Java-classes and not directly in the TLD files?

      Anyway JavaDoc is generating the HTML documentation in the taglib part (e.g. http://www.jahia.org/taglibdoc/content/containerList.html), while the JavaDoc descriptions for Java file is empty in the getter/setter methods (e.g. http://www.jahia.org/javadoc-dev_5/org/jahia/taglibs/container/ContainerListTag.html).

      I would prefer if we would document directly in the TLD file, because this way the Code Assist of Eclipse (and probably IDEA) will show the description of the tags and its attributes while I am edting my template JSPs and thus will help developers for their productivity a lot, than having to first find Jahia's JavaDoc page and navigate to the wanted tag/attribute.

      TestRail: Results

        Attachments

          Activity

            People

              dgriffon_old David Griffon (Inactive)
              pap@commaro.com_old Benjamin Papez (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:

                TestRail: Runs

                  TestRail: Cases

                    Packages

                      Version Package
                      xCM 6.0.0