Uploaded image for project: 'Apache Apex Malhar'
  1. Apache Apex Malhar
  2. APEXMALHAR-833

Add required documentation tags to the class level comments.

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Major
    • Resolution: Won't Fix
    • None
    • None
    • documentation
    • None

    Description

      We need to add following documentation tags to Malhar operator library and contrib apps.

      For the operators that are of type Output - add tag - @dt-output

      For the operators that are of type adapters to external entities such as CouchDB, HBase... ad tag - @dt-adapter <external-entity-name>. For example, all the operators such as Input and Output that work with CouchDB, the tag to be added would be - @dt-adapter CouchDB

      These tags need to be added at class level documentation comment.

      This is needed so that DataTorrent Doclet can generate appropriate index pages - Operators, Adapters.

      Attachments

        Activity

          People

            thw Thomas Weise
            AtulDambalkar Atul Dambalkar
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: