[trinidad] javascript documentation using jsdoc

[Leonardo Uribe]

Hi

I tried to add this to trinidad-impl pom.xml:

  <profiles>
    <profile>
          <id>generate-assembly</id>
          <build>
        <plugins>
          <plugin>
            <groupId>org.apache.myfaces.buildtools</groupId>
            <artifactId>myfaces-jsdoc-plugin</artifactId>
            <version>1.0-beta-1</version>
            <executions>
               <execution>
                  <id>attach-jsdoc</id>
                  <goals>
                     <goal>jar</goal>
                  </goals>
               </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
        </profile>
  </profiles>

It is the same we use in myfaces core to generate javascript doc. The
good news is it works. We could add it as a report to generate it when
the site is build or include it as a jar.

But before do that, we need to add the proper jsdoc annotations.
Unfortunately, I get lost in the pattern used to annotate classes.

Does anybody knows which are the used code conventions in that part?.
For example in TrPanelPopup for example:

function TrPanelPopup()
{
  //define object properties
  this._content = false;
  this._trigger = false;
  this._centered = false;
  this._modal = false;
  this._visible = false;
}

TrPanelPopup.prototype.getContent = function()

What is prototype? the body of the class?.

I think with the work already done to generate the jsdoc in myfaces
core, generate the same info for trinidad is easy, but obviously jsdoc
annotations are a little bit tricky.

regards,

Leonardo Uribe