Examples of com.google.javascript.rhino.JSDocInfo

com.google.javascript.rhino.JSDocInfo

JSDoc information describing JavaScript code. JSDoc is represented as a unified object with fields for each JSDoc annotation, even though some combinations are incorrect. For instance, if a JSDoc describes an enum, it cannot have information about a return type. This implementation takes advantage of such incompatibilities to reuse fields for multiple purposes, reducing memory consumption.

Constructing {@link JSDocInfo} objects is simplified by{@link JSDocInfoBuilder} which provides early incompatibility detection.

  public void testInlineJSDocAttachment2() {
    Node fn = parse(
        "function f(/** ? */ x) {}").getFirstChild();
    assertTrue(fn.isFunction());


    JSDocInfo info =
        fn.getFirstChild().getNext().getFirstChild().getJSDocInfo();
    assertNotNull(info);
    assertTypeEquals(UNKNOWN_TYPE, info.getType());
  }

View Full Code Here

        "Bad type annotation. type not recognized due to syntax error");
  }


  public void testInlineJSDocAttachment5() {
    Node vardecl = parse("var /** string */ x = 'asdf';").getFirstChild();
    JSDocInfo info = vardecl.getFirstChild().getJSDocInfo();
    assertNotNull(info);
    assertTrue(info.hasType());
    assertTypeEquals(STRING_TYPE, info.getType());
  }

View Full Code Here


  public void testInlineJSDocAttachment6() {
    Node fn = parse("function f(/** {attr: number} */ x) {}").getFirstChild();
    assertTrue(fn.isFunction());


    JSDocInfo info =
        fn.getFirstChild().getNext().getFirstChild().getJSDocInfo();
    assertNotNull(info);
    assertTypeEquals(createRecordTypeBuilder().
        addProperty("attr", NUMBER_TYPE, null).
        build(),
        info.getType());
  }

View Full Code Here

  public void testJSDocAttachment1() {
    Node varNode = parse("/** @type number */var a;").getFirstChild();


    // VAR
    assertEquals(Token.VAR, varNode.getType());
    JSDocInfo varInfo = varNode.getJSDocInfo();
    assertNotNull(varInfo);
    assertTypeEquals(NUMBER_TYPE, varInfo.getType());


    // VAR NAME
    Node varNameNode = varNode.getFirstChild();
    assertEquals(Token.NAME, varNameNode.getType());
    assertNull(varNameNode.getJSDocInfo());


    mode = LanguageMode.ECMASCRIPT6;


    Node letNode = parse("/** @type number */let a;").getFirstChild();


    // LET
    assertEquals(Token.LET, letNode.getType());
    JSDocInfo letInfo = letNode.getJSDocInfo();
    assertNotNull(letInfo);
    assertTypeEquals(NUMBER_TYPE, letInfo.getType());


    // LET NAME
    Node letNameNode = letNode.getFirstChild();
    assertEquals(Token.NAME, letNameNode.getType());
    assertNull(letNameNode.getJSDocInfo());


    Node constNode = parse("/** @type number */const a = 0;").getFirstChild();


    // CONST
    assertEquals(Token.CONST, constNode.getType());
    JSDocInfo constInfo = constNode.getJSDocInfo();
    assertNotNull(constInfo);
    assertTypeEquals(NUMBER_TYPE, constInfo.getType());


    // LET NAME
    Node constNameNode = constNode.getFirstChild();
    assertEquals(Token.NAME, constNameNode.getType());
    assertNull(constNameNode.getJSDocInfo());

View Full Code Here

  public void testJSDocAttachment2() {
    Node varNode = parse("/** @type number */var a,b;").getFirstChild();


    // VAR
    assertEquals(Token.VAR, varNode.getType());
    JSDocInfo info = varNode.getJSDocInfo();
    assertNotNull(info);
    assertTypeEquals(NUMBER_TYPE, info.getType());


    // First NAME
    Node nameNode1 = varNode.getFirstChild();
    assertEquals(Token.NAME, nameNode1.getType());
    assertNull(nameNode1.getJSDocInfo());

View Full Code Here


  public void testJSDocAttachment3() {
    Node assignNode = parse(
        "/** @type number */goog.FOO = 5;").getFirstChild().getFirstChild();
    assertEquals(Token.ASSIGN, assignNode.getType());
    JSDocInfo info = assignNode.getJSDocInfo();
    assertNotNull(info);
    assertTypeEquals(NUMBER_TYPE, info.getType());
  }

View Full Code Here

    Node a = varNode.getFirstChild();
    assertNull(a.getJSDocInfo());


    // b
    Node b = a.getNext();
    JSDocInfo info = b.getJSDocInfo();
    assertNotNull(info);
    assertTrue(info.isDefine());
    assertTypeEquals(NUMBER_TYPE, info.getType());
  }

View Full Code Here

    } else {
      builder = JSDocInfoBuilder.copyFrom(n.getJSDocInfo());
    }
    //TODO(mattloring): copy existing suppressions.
    builder.recordSuppressions(ImmutableSet.of("uselessCode"));
    JSDocInfo info = builder.build(n);
    n.setJSDocInfo(info);




    // Set state to the default after the body of the function has completed.
    originalGeneratorBody.addChildToBack(

View Full Code Here

   * @return true if message has JsDoc with valid description in @desc
   *         annotation
   */
  private static boolean maybeInitMetaDataFromJsDoc(Builder builder, Node node) {
    boolean messageHasDesc = false;
    JSDocInfo info = node.getJSDocInfo();
    if (info != null) {
      String desc = info.getDescription();
      if (desc != null) {
        builder.setDesc(desc);
        messageHasDesc = true;
      }
      if (info.isHidden()) {
        builder.setIsHidden(true);
      }
      if (info.getMeaning() != null) {
        builder.setMeaning(info.getMeaning());
      }
    }


    return messageHasDesc;
  }

View Full Code Here

  /**
   * Get the JSDocInfo for a function.
   */
  public static JSDocInfo getFunctionJSDocInfo(Node n) {
    Preconditions.checkState(n.isFunction());
    JSDocInfo fnInfo = n.getJSDocInfo();
    if (fnInfo == null && NodeUtil.isFunctionExpression(n)) {
      // Look for the info on other nodes.
      Node parent = n.getParent();
      if (parent.isAssign()) {
        // on ASSIGNs

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of com.google.javascript.rhino.JSDocInfo

com.google.javascript.jscomp.AccessControlUtils

com.google.javascript.jscomp.AliasExternals$GetGlobals

com.google.javascript.jscomp.AngularPass

com.google.javascript.jscomp.CheckAccessControls

com.google.javascript.jscomp.CheckEventfulObjectDisposal$ComputeEventizeTraversal

com.google.javascript.jscomp.CheckEventfulObjectDisposal$Traversal

com.google.javascript.jscomp.CheckGlobalNames

com.google.javascript.jscomp.CheckGlobalThis

com.google.javascript.jscomp.CheckProvides$CheckProvidesCallback

com.google.javascript.jscomp.CheckRequiresForConstructors$CheckRequiresForConstructorsCallback

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.