Examples of uk.co.badgersinfoil.metaas.dom.DocTag

uk.co.badgersinfoil.metaas.dom.DocTag
A 'block' tag within a {@link DocComment}.
The start of a block tag is indicated within the comment by an '@'-prefixed word appearing at the start of a line (ignoring optional leading whitespace and '*' characters).

For example the following comment includes a 'see' block tag:
```
/ * Good. * @see MyClass */
```
If this text is not the first thing on the line, it is not interpreted as a block tag. Here, '@see' will just be interpreted as part of the description text, and metaas will not generate a DocTag for it:
```
/ * Bad. @see MyClass */
```
@see DocComment#addParaTag(String,String) @see DocComment#delete(DocTag) @see DocComment#findFirstTag(String) @see DocComment#findTags(String)

  }


  public String getDescriptionString() {
    DocComment doc = getMethod().getDocumentation();
    String name = getName();
    DocTag tag = DocCommentUtils.findParam(doc, name);
    if (tag == null) {
      return null;
    }
    return tag.getBodyString().substring(name.length()+1);
  }

View Full Code Here

  }


  public void setDescription(String description) {
    ASTDocComment doc = (ASTDocComment)getMethod().getDocumentation();
    String name = getName();
    DocTag tag = DocCommentUtils.findParam(doc, name);
    if (tag == null) {
      doc.addParaTag("param", name+" "+description);
    } else {
      tag.setBody(name+" "+description);
    }
  }

View Full Code Here

    return stmtList().getStatementList();
  }


  public String getReturnDescriptionString() {
    DocComment doc = getDocumentation();
    DocTag ret = doc.findFirstTag("return");
    if (ret == null) {
      return null;
    }
    return ret.getBodyString();
  }

View Full Code Here

    return ret.getBodyString();
  }


  public void setReturnDescription(String description) {
    DocComment doc = getDocumentation();
    DocTag ret = doc.findFirstTag("return");
    if (ret == null) {
      if (description != null) {
        doc.addParaTag("return", description);
      }
    } else {
      if (description == null) {
        doc.delete(ret);
      } else {
        ret.setBody(description);
      }
    }
  }

View Full Code Here


  public static DocTag findParam(DocComment doc, String name) {
    Iterator params = doc.findTags("param");
    Pattern p = Pattern.compile("\\s*\\Q"+name+"\\E\\b");
    while (params.hasNext()) {
      DocTag param = (DocTag)params.next();
      if (p.matcher(param.getBodyString()).lookingAt()) {
        return param;
      }
    }
    return null;
  }

View Full Code Here

TOP

Related Classes of uk.co.badgersinfoil.metaas.dom.DocTag

uk.co.badgersinfoil.metaas.impl.ASTASArg

uk.co.badgersinfoil.metaas.impl.ASTASMethod

uk.co.badgersinfoil.metaas.impl.DocCommentUtils

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.