All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.javascript.jscomp.parsing.Annotation Maven / Gradle / Ivy

Go to download

Closure Compiler is a JavaScript optimizing compiler. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what's left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls. It is used in many of Google's JavaScript apps, including Gmail, Google Web Search, Google Maps, and Google Docs.

There is a newer version: v20240317
Show newest version
/*
 * Copyright 2010 The Closure Compiler Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.javascript.jscomp.parsing;

import com.google.common.collect.ImmutableMap;

/** All natively recognized JSDoc annotations. */
enum Annotation {
  ABSTRACT,
  ALTERNATE_MESSAGE_ID,
  AUTHOR,
  CLOSURE_PRIMITIVE,
  COLLAPSIBLE_OR_BREAK_MY_CODE,
  CONSTANT,
  CONSTRUCTOR,
  CUSTOM_ELEMENT,
  RECORD,
  DEFINE,
  DEPRECATED,
  DESC,
  DICT,
  ENHANCE,
  ENUM,
  EXTENDS,
  EXTERNS,
  EXPORT,
  FILE_OVERVIEW,
  FINAL,
  HIDDEN,
  IDGENERATOR,
  IMPLEMENTS,
  IMPLICIT_CAST,
  INHERIT_DOC,
  INTERFACE,
  JSX,
  JSX_FRAGMENT,
  LENDS,
  LICENSE, // same as preserve
  LOG_TYPE_IN_COMPILER,
  MEANING,
  MIXIN_CLASS,
  MIXIN_FUNCTION,
  MODIFIES,
  NG_INJECT,
  NO_COLLAPSE,
  NO_COMPILE,
  /**
   * A tag to suppress clutz's d.ts generation for classes and method. This is specifically for the
   * use of J2CL.
   *
   * 

Annotating classes, class methods and fields with @nodts has a side effect of not triggering * a hard error on the code which the extended subclass unintentionally reuses the same property * from base class. The author of the code using this tag should be specifically aware of this and * should be able to communicate this to the consumers of their code. */ NO_DTS, NO_INLINE, NO_SIDE_EFFECTS, NOT_IMPLEMENTED, OVERRIDE, PACKAGE, PARAM, POLYMER, POLYMER_BEHAVIOR, PRESERVE, // same as license PRIVATE, PROTECTED, PROVIDE_GOOG, // @provideGoog - appears only in base.js PROVIDE_ALREADY_PROVIDED, PUBLIC, PURE_OR_BREAK_MY_CODE, RETURN, SEE, SOY_MODULE, SOY_TEMPLATE, STRUCT, SUPPRESS, TEMPLATE, THIS, THROWS, TYPE, TYPEDEF, TYPE_SUMMARY, UNRESTRICTED, WIZACTION, TS_TYPE, WIZCALLBACK; static final ImmutableMap recognizedAnnotations = new ImmutableMap.Builder() .put("ngInject", Annotation.NG_INJECT) .put("abstract", Annotation.ABSTRACT) .put("alternateMessageId", Annotation.ALTERNATE_MESSAGE_ID) .put("argument", Annotation.PARAM) .put("author", Annotation.AUTHOR) .put("closurePrimitive", Annotation.CLOSURE_PRIMITIVE) .put("const", Annotation.CONSTANT) .put("collapsibleOrBreakMyCode", Annotation.COLLAPSIBLE_OR_BREAK_MY_CODE) .put("constant", Annotation.CONSTANT) .put("constructor", Annotation.CONSTRUCTOR) .put("customElement", Annotation.CUSTOM_ELEMENT) .put("copyright", Annotation.LICENSE) .put("define", Annotation.DEFINE) .put("deprecated", Annotation.DEPRECATED) .put("desc", Annotation.DESC) .put("dict", Annotation.DICT) .put("enum", Annotation.ENUM) .put("enhance", Annotation.ENHANCE) .put("export", Annotation.EXPORT) .put("extends", Annotation.EXTENDS) .put("externs", Annotation.EXTERNS) .put("fileoverview", Annotation.FILE_OVERVIEW) .put("final", Annotation.FINAL) .put("hidden", Annotation.HIDDEN) .put("idGenerator", Annotation.IDGENERATOR) .put("implements", Annotation.IMPLEMENTS) .put("implicitCast", Annotation.IMPLICIT_CAST) .put("inheritDoc", Annotation.INHERIT_DOC) .put("interface", Annotation.INTERFACE) .put("record", Annotation.RECORD) .put("lends", Annotation.LENDS) .put("license", Annotation.LICENSE) .put("logTypeInCompiler", Annotation.LOG_TYPE_IN_COMPILER) .put("meaning", Annotation.MEANING) .put("mixinClass", Annotation.MIXIN_CLASS) .put("mixinFunction", Annotation.MIXIN_FUNCTION) .put("modifies", Annotation.MODIFIES) .put("nocollapse", Annotation.NO_COLLAPSE) .put("nocompile", Annotation.NO_COMPILE) .put("nodts", Annotation.NO_DTS) .put("noinline", Annotation.NO_INLINE) .put("nosideeffects", Annotation.NO_SIDE_EFFECTS) .put("override", Annotation.OVERRIDE) .put("owner", Annotation.AUTHOR) .put("package", Annotation.PACKAGE) .put("param", Annotation.PARAM) .put("polymer", Annotation.POLYMER) .put("polymerBehavior", Annotation.POLYMER_BEHAVIOR) .put("preserve", Annotation.PRESERVE) .put("private", Annotation.PRIVATE) .put("protected", Annotation.PROTECTED) .put("provideGoog", Annotation.PROVIDE_GOOG) .put("provideAlreadyProvided", Annotation.PROVIDE_ALREADY_PROVIDED) .put("public", Annotation.PUBLIC) .put("pureOrBreakMyCode", Annotation.PURE_OR_BREAK_MY_CODE) .put("return", Annotation.RETURN) .put("returns", Annotation.RETURN) .put("see", Annotation.SEE) .put("soyModule", Annotation.SOY_MODULE) .put("soyTemplate", Annotation.SOY_TEMPLATE) .put("struct", Annotation.STRUCT) .put("suppress", Annotation.SUPPRESS) .put("template", Annotation.TEMPLATE) .put("this", Annotation.THIS) .put("throws", Annotation.THROWS) .put("type", Annotation.TYPE) .put("typedef", Annotation.TYPEDEF) .put("typeSummary", Annotation.TYPE_SUMMARY) .put("unrestricted", Annotation.UNRESTRICTED) .put("wizaction", Annotation.WIZACTION) .put("tsType", Annotation.TS_TYPE) .put("wizcallback", Annotation.WIZCALLBACK) .buildOrThrow(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy