Examples with Type com.thoughtworks.qdox.model.Type used on opensource projects

Example 1 with Type

use of com.thoughtworks.qdox.model.Type in project jsonschema2pojo by joelittlejohn.

the class TitleIT method descriptionAppearsInSetterJavadoc.

@Test
public void descriptionAppearsInSetterJavadoc() throws IOException {
    JavaMethod javaMethod = classWithTitle.getMethodBySignature("setTitle", new Type[] { new Type("java.lang.String") });
    String javaDocComment = javaMethod.getComment();
    assertThat(javaDocComment, containsString("A title for this property"));
}

Example 2 with Type

use of com.thoughtworks.qdox.model.Type in project jsonschema2pojo by joelittlejohn.

the class RequiredArrayIT method requiredAppearsInSetterJavadoc.

@Test
public void requiredAppearsInSetterJavadoc() throws IOException {
    JavaMethod javaMethod = classWithRequired.getMethodBySignature("setRequiredProperty", new Type[] { new Type("java.lang.String") });
    String javaDocComment = javaMethod.getComment();
    assertThat(javaDocComment, containsString("(Required)"));
}

Example 3 with Type

use of com.thoughtworks.qdox.model.Type in project jsonschema2pojo by joelittlejohn.

the class RequiredIT method requiredAppearsInSetterJavadoc.

@Test
public void requiredAppearsInSetterJavadoc() throws IOException {
    JavaMethod javaMethod = classWithRequired.getMethodBySignature("setRequiredProperty", new Type[] { new Type("java.lang.String") });
    String javaDocComment = javaMethod.getComment();
    assertThat(javaDocComment, containsString("(Required)"));
}

Example 4 with Type

use of com.thoughtworks.qdox.model.Type in project jsonschema2pojo by joelittlejohn.

the class DescriptionIT method descriptionAppearsInSetterJavadoc.

@Test
public void descriptionAppearsInSetterJavadoc() throws IOException {
    JavaMethod javaMethod = classWithDescription.getMethodBySignature("setDescription", new Type[] { new Type("java.lang.String") });
    String javaDocComment = javaMethod.getComment();
    assertThat(javaDocComment, containsString("A description for this property"));
}

Example 5 with Type

use of com.thoughtworks.qdox.model.Type in project maven-plugins by apache.

the class AbstractFixJavadocMojo method addDefaultMethodComment.

/**
     * Add in the buffer a default Javadoc for the given class:
     * <br/>
     * <code>
     * <font color="#808080">1</font>&nbsp;<font color="#ffffff">&nbsp;</font>
     * <font color="#3f5fbf">&#47;&#42;&#42;</font><br />
     * <font color="#808080">2</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&nbsp;{Comment&nbsp;based&nbsp;on&nbsp;the&nbsp;method&nbsp;name}</font><br />
     * <font color="#808080">3</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;</font><br />
     * <font color="#808080">4</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&nbsp;</font><font color="#7f9fbf">@param&nbsp;</font>
     * <font color="#3f5fbf">X&nbsp;{added&nbsp;if&nbsp;addMissingParam}</font><br />
     * <font color="#808080">5</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&nbsp;</font><font color="#7f9fbf">@return&nbsp;</font>
     * <font color="#3f5fbf">X&nbsp;{added&nbsp;if&nbsp;addMissingReturn}</font><br />
     * <font color="#808080">6</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&nbsp;</font><font color="#7f9fbf">@throws&nbsp;</font>
     * <font color="#3f5fbf">X&nbsp;{added&nbsp;if&nbsp;addMissingThrows}</font><br />
     * <font color="#808080">7</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&nbsp;</font><font color="#7f9fbf">@since&nbsp;</font>
     * <font color="#3f5fbf">X&nbsp;{added&nbsp;if&nbsp;addMissingSince&nbsp;and&nbsp;new&nbsp;classes
     * from&nbsp;previous&nbsp;version}</font><br />
     * <font color="#808080">8</font>&nbsp;<font color="#ffffff">&nbsp;&nbsp;</font>
     * <font color="#3f5fbf">&#42;&#47;</font><br />
     * <font color="#808080">9</font>&nbsp;<font color="#7f0055"><b>public&nbsp;</b></font>
     * <font color="#7f0055"><b>void&nbsp;</b></font><font color="#000000">dummyMethod</font>
     * <font color="#000000">(&nbsp;</font><font color="#000000">String&nbsp;s&nbsp;</font>
     * <font color="#000000">){}</font>
     * </code>
     *
     * @param buffer     not null
     * @param javaMethod not null
     * @param indent     not null
     * @throws MojoExecutionException if any
     * @see #getDefaultMethodJavadocComment(JavaMethod)
     * @see #appendDefaultSinceTag(StringBuilder, String)
     */
private void addDefaultMethodComment(final StringWriter stringWriter, final JavaMethod javaMethod, final String indent) throws MojoExecutionException {
    StringBuilder sb = new StringBuilder();
    // special case
    if (isInherited(javaMethod)) {
        sb.append(indent).append(INHERITED_JAVADOC);
        sb.append(EOL);
        stringWriter.write(sb.toString());
        return;
    }
    sb.append(indent).append(START_JAVADOC);
    sb.append(EOL);
    sb.append(indent).append(SEPARATOR_JAVADOC);
    sb.append(getDefaultMethodJavadocComment(javaMethod));
    sb.append(EOL);
    boolean separatorAdded = false;
    if (fixTag(PARAM_TAG)) {
        if (javaMethod.getParameters() != null) {
            for (int i = 0; i < javaMethod.getParameters().length; i++) {
                JavaParameter javaParameter = javaMethod.getParameters()[i];
                separatorAdded = appendDefaultParamTag(sb, indent, separatorAdded, javaParameter);
            }
        }
        // is generic?
        if (javaMethod.getTypeParameters() != null) {
            for (int i = 0; i < javaMethod.getTypeParameters().length; i++) {
                TypeVariable typeParam = javaMethod.getTypeParameters()[i];
                separatorAdded = appendDefaultParamTag(sb, indent, separatorAdded, typeParam);
            }
        }
    }
    if (fixTag(RETURN_TAG) && javaMethod.getReturns() != null && !javaMethod.getReturns().isVoid()) {
        separatorAdded = appendDefaultReturnTag(sb, indent, separatorAdded, javaMethod);
    }
    if (fixTag(THROWS_TAG) && javaMethod.getExceptions() != null && javaMethod.getExceptions().length > 0) {
        for (int i = 0; i < javaMethod.getExceptions().length; i++) {
            Type exception = javaMethod.getExceptions()[i];
            separatorAdded = appendDefaultThrowsTag(sb, indent, separatorAdded, exception);
        }
    }
    if (fixTag(SINCE_TAG) && isNewMethodFromLastRevision(javaMethod)) {
        separatorAdded = appendDefaultSinceTag(sb, indent, separatorAdded);
    }
    sb.append(indent).append(" ").append(END_JAVADOC);
    sb.append(EOL);
    stringWriter.write(sb.toString());
}