private static List<MethodInspect> getInspects(ExecutableMemberDoc[] memberDocs) { List<MethodInspect> methodInspects = new ArrayList<>(memberDocs.length); for (ExecutableMemberDoc memberDoc : memberDocs) { List<String> signature = new ArrayList<>(); for (Parameter parameter : memberDoc.parameters()) { signature.add(parameter.type().qualifiedTypeName() + " " + parameter.name()); } MethodInspect methodInspect = new MethodInspect(memberDoc.name(), memberDoc.getRawCommentText(), String.join(", ", signature)); methodInspects.add(methodInspect); } return methodInspects; } }
@Override public String apply(Parameter param) { return param.name(); } }));
@Override public String apply(Parameter param) { return "${" + i++ + ":" + param.name() + "}"; } }));
/** Print the method parameter p */ private String parameter(Options opt, Parameter p[]) { StringBuilder par = new StringBuilder(1000); for (int i = 0; i < p.length; i++) { par.append(p[i].name() + typeAnnotation(opt, p[i].type())); if (i + 1 < p.length) par.append(", "); } return par.toString(); }
/** * Given an array of <code>Parameter</code>s, return * a name/rank number map. If the array is null, then * null is returned. * @param params The array of parmeters (from type or executable member) to * check. * @return a name-rank number map. */ private static Map<String,String> getRankMap(Object[] params){ if (params == null) { return null; } HashMap<String,String> result = new HashMap<String,String>(); for (int i = 0; i < params.length; i++) { String name = params[i] instanceof Parameter ? ((Parameter) params[i]).name() : ((TypeVariable) params[i]).typeName(); result.put(name, String.valueOf(i)); } return result; }
/** * Given an array of <code>Parameter</code>s, return * a name/rank number map. If the array is null, then * null is returned. * @param params The array of parmeters (from type or executable member) to * check. * @return a name-rank number map. */ private static Map<String,String> getRankMap(Object[] params){ if (params == null) { return null; } HashMap<String,String> result = new HashMap<String,String>(); for (int i = 0; i < params.length; i++) { String name = params[i] instanceof Parameter ? ((Parameter) params[i]).name() : ((TypeVariable) params[i]).typeName(); result.put(name, String.valueOf(i)); } return result; }
private boolean swaggerToJavadocMatch(String swaggerParameterName, com.sun.javadoc.Parameter jParameter) { // // Its possible that the JAXRS annotation QueryParam is different to the method parameter // eg: // method( QueryParam("name") personName, ...) // // The javadoc for the above must be // @param personName this is a nice description // // But the swagger doc MUST be "name" as this is what the API url must contain. // // So in order to get better documentation, we need to be a little clever. The // swaggerParameterName here is the parsed "annotation value" now and NOT the method // parameter name so... we have to reverse that look up // AnnotationParser parser = new AnnotationParser(jParameter, options); return ImmutableList.of(QueryParam.class, PathParam.class, HeaderParam.class, CookieParam.class, FormParam.class, MultipartFormParam.class).stream() .anyMatch(annotation -> annotationMatches(swaggerParameterName, parser, annotation)) || jParameter.name().equals(swaggerParameterName); }
/** Print the method parameter p */ private String parameter(Options opt, Parameter p[]) { String par = ""; for (int i = 0; i < p.length; i++) { par += p[i].name() + typeAnnotation(opt, p[i].type()); if (i + 1 < p.length) par += ", "; } return par; }
private static String commentForParameter(ExecutableMemberDoc method, com.sun.javadoc.Parameter parameter) { for (ParamTag tag : method.paramTags()) { if (tag.parameterName().equals(parameter.name())) { return tag.parameterComment(); } } return ""; }
private static void maybeUpdateName(Parameter swaggerParameter, com.sun.javadoc.Parameter parameter) { if (DEFAULT_NAMES.contains(swaggerParameter.getName())) { String name = StringUtils.stripToNull(parameter.name()); if (name != null) { swaggerParameter.setName(name); } } }
protected void writeParam(ExecutableMemberDoc member, Parameter param, boolean isVarArg) { if (param.type() != null) { writer.printLink(new LinkInfoImpl( LinkInfoImpl.CONTEXT_EXECUTABLE_MEMBER_PARAM, param.type(), isVarArg)); } if(param.name().length() > 0) { writer.space(); writer.print(param.name()); } }
(ParamTag) inheritedDoc.holderTag, isNonTypeParams ? ((Parameter) formalParameters[i]).name(): ((TypeVariable) formalParameters[i]).typeName(), alreadyDocumented.size() == 0));
(ParamTag) inheritedDoc.holderTag, isNonTypeParams ? ((Parameter) formalParameters[i]).name(): ((TypeVariable) formalParameters[i]).typeName(), alreadyDocumented.size() == 0));
public static boolean start(RootDoc root) throws IOException { String dumpFileName = readOptions(root.options()); OutputStream os = Files.newOutputStream(Paths.get(dumpFileName)); Properties javaDocMap = new Properties(); for (ClassDoc classDoc : root.classes()) { javaDocMap.put(classDoc.toString(), classDoc.commentText()); for (MethodDoc method : classDoc.methods()) { javaDocMap.put(method.qualifiedName(), method.commentText()); for (ParamTag paramTag : method.paramTags()) { Parameter[] parameters = method.parameters(); for (int i = 0; i < parameters.length; ++i) { if (parameters[i].name().equals(paramTag.parameterName())) { javaDocMap.put(method.qualifiedName() + ".paramCommentTag." + i, paramTag.parameterComment()); } } } Tag[] retTags = method.tags("return"); if (retTags != null && retTags.length == 1) { Tag retTag = method.tags("return")[0]; javaDocMap.put(method.qualifiedName() + "." + "returnCommentTag", retTag.text()); } } } javaDocMap.store(os, ""); os.flush(); os.close(); return true; }
public static boolean start(RootDoc root) throws IOException { String dumpFileName = readOptions(root.options()); OutputStream os = Files.newOutputStream(Paths.get(dumpFileName)); Properties javaDocMap = new Properties(); for (ClassDoc classDoc : root.classes()) { javaDocMap.put(classDoc.toString(), classDoc.commentText()); for (MethodDoc method : classDoc.methods()) { javaDocMap.put(method.qualifiedName(), method.commentText()); for (ParamTag paramTag : method.paramTags()) { Parameter[] parameters = method.parameters(); for (int i = 0; i < parameters.length; ++i) { if (parameters[i].name().equals(paramTag.parameterName())) { javaDocMap.put(method.qualifiedName() + ".paramCommentTag." + i, paramTag.parameterComment()); } } } Tag[] retTags = method.tags("return"); if (retTags != null && retTags.length == 1) { Tag retTag = method.tags("return")[0]; javaDocMap.put(method.qualifiedName() + "." + "returnCommentTag", retTag.text()); } } } javaDocMap.store(os, ""); os.flush(); os.close(); return true; }
/** * Add the parameter for the executable member. * * @param member the member to write parameter for. * @param param the parameter that needs to be written. * @param isVarArg true if this is a link to var arg. * @param tree the content tree to which the parameter information will be added. */ protected void addParam(ExecutableMemberDoc member, Parameter param, boolean isVarArg, Content tree) { if (param.type() != null) { Content link = writer.getLink(new LinkInfoImpl( configuration, LinkInfoImpl.Kind.EXECUTABLE_MEMBER_PARAM, param.type()).varargs(isVarArg)); tree.addContent(link); } if(param.name().length() > 0) { tree.addContent(writer.getSpace()); tree.addContent(param.name()); } }
protected MethodParameter parseMethodParameter(Parameter parameter) { MethodParameter parameterMethodNode = objectFactory.createMethodParameter(); parameterMethodNode.setName(parameter.name()); parameterMethodNode.setType(parseTypeInfo(parameter.type())); for (AnnotationDesc annotationDesc : parameter.annotations()) { parameterMethodNode.getAnnotation().add(parseAnnotationDesc(annotationDesc, parameter.typeName())); } return parameterMethodNode; }
for (Parameter parameter : method.parameters()) { Type type = parameter.type(); String name = parameter.name(); String comment = null; for (ParamTag paramTag : paramTags) {
for (Parameter parameter : method.parameters()) { Type type = parameter.type(); String name = parameter.name(); String comment = null; for (ParamTag paramTag : paramTags) {
for (paramstart = 0; paramstart < params.length; paramstart++) { Parameter param = params[paramstart]; if (!param.name().startsWith("this$")) { if (includeAnnotations) { boolean foundAnnotations =