Examples of com.sun.javadoc.ParamTag

com.sun.javadoc.ParamTag
Represents an @param documentation tag. Stores the name and comment parts of the parameter tag. An @param tag may represent either a method or constructor parameter, or a type parameter. @author Robert Field

      if (tagKind.equals("Text")) {
        text(tag.text());
      } else if (tagKind.equals("@see")) {
        processSeeTag((SeeTag) tag);
      } else if (tagKind.equals("@param")) {
        ParamTag paramTag = (ParamTag) tag;
        beginln("param");
        begin("name");
        text(paramTag.parameterName());
        end();
        begin("description");
        processTags(paramTag.inlineTags());
        end();
        endln();
      } else if (tagKind.equals("@example")) {
        ExtraClassResolver extraClassResolver = getExtraClassResolver(tag);
        SourcePosition pos = LinkResolver.resolveLink(tag, extraClassResolver);

View Full Code Here

      ParamTag [] parameterTags = constructorDoc.paramTags ();


      // Check to see whether the current constructor has javadoc for the
      // parameter which matches this field.
      for (int t = 0; t < parameterTags.length; t += 1) {
        ParamTag tag = parameterTags [t];
        String name = tag.parameterName ();
        if (parameterName.equals (name)) {
          return tag.parameterComment ();
        }
      }
    }


    if (defaultComment == null) {

View Full Code Here

                // param tags
                ParamTag[] paramTags = methodDoc.paramTags();
                if (parameters.length > 0) {
                    mOut.println("<DT><B>Parameters:</B></DT>");
                    for (Parameter parameter : parameters) {
                        ParamTag paramTag = null;
                        for (ParamTag tag : paramTags) {
                            if (tag.parameterName().equals(parameter.name())) {
                                paramTag = tag;
                            }
                        }
                        mOut.println("<DD><CODE>" + parameter.name() + "</CODE> - ");
                        if (paramTag != null) {
                            if (!paramTag.parameterComment().isEmpty()) {
                                printInlineTags(paramTag.inlineTags(), classDoc);
                            } else {
                                System.out.println("No description in @param tag for " + parameter.name() + " in " + classDoc.name() + "." + methodDoc.name());
                            }
                        } else {
                            System.out.println("No @param tag for " + parameter.name() + " in " + classDoc.name() + "." + methodDoc.name());

View Full Code Here


                /* TODO: this only works if the params and tags are in the same
                 * order. If the param tags are mixed up, the comments for parameters
                 * will be wrong.
                 */
                final ParamTag paramTag = paramTags[i];


                final ParamDocType paramDocType = new ParamDocType();
                paramDocType.setParamName(paramTag.parameterName());
                paramDocType.setCommentText(paramTag.parameterComment());
                docProcessor.processParamTag(paramTag, parameter, paramDocType);


                AnnotationDesc[] annotations = parameter.annotations();
                if (annotations != null) {
                    for (AnnotationDesc annotationDesc : annotations) {

View Full Code Here


                /* TODO: this only works if the params and tags are in the same
                 * order. If the param tags are mixed up, the comments for parameters
                 * will be wrong.
                 */
                final ParamTag paramTag = paramTags[i];


                final ParamDocType paramDocType = new ParamDocType();
                paramDocType.setParamName(paramTag.parameterName());
                paramDocType.setCommentText(paramTag.parameterComment());
                docProcessor.processParamTag(paramTag, parameter, paramDocType);


                final AnnotationDesc[] annotations = parameter.annotations();
                if (annotations != null) {
                    for (final AnnotationDesc annotationDesc : annotations) {

View Full Code Here

                
                /* TODO: this only works if the params and tags are in the same
                 * order. If the param tags are mixed up, the comments for parameters
                 * will be wrong.
                 */
                final ParamTag paramTag = paramTags[i];
                
                final ParamDocType paramDocType = new ParamDocType();
                paramDocType.setParamName( paramTag.parameterName() );
                paramDocType.setCommentText( paramTag.parameterComment() );
                docProcessor.processParamTag( paramTag, parameter, paramDocType );
                
                AnnotationDesc[] annotations = parameter.annotations();
                if ( annotations != null  ) {
                    for ( AnnotationDesc annotationDesc : annotations ) {

View Full Code Here

                
                /* TODO: this only works if the params and tags are in the same
                 * order. If the param tags are mixed up, the comments for parameters
                 * will be wrong.
                 */
                final ParamTag paramTag = paramTags[i];
                
                final ParamDocType paramDocType = new ParamDocType();
                paramDocType.setParamName( paramTag.parameterName() );
                paramDocType.setCommentText( paramTag.parameterComment() );
                docProcessor.processParamTag( paramTag, parameter, paramDocType );
                
                AnnotationDesc[] annotations = parameter.annotations();
                if ( annotations != null  ) {
                    for ( AnnotationDesc annotationDesc : annotations ) {

View Full Code Here

TOP

Related Classes of com.sun.javadoc.ParamTag

com.google.doctool.Booklet

com.qspin.qtaste.toolbox.doclet.HTMLFileWriter

com.sun.jersey.wadl.resourcedoc.ResourceDoclet

com.volantis.mcs.build.objects.RepositoryObjectInfo

org.glassfish.jersey.wadl.doclet.ResourceDoclet

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.