Add readonly tag

Author: ShukantPal

packages/webdoc-parser/src/tag-parsers/index.js

@@ -20,6 +20,7 @@ export {
   parseTodo,
   parseThrows,
   parseType,
+  parseReadonly,
   parseSee,
   parseSince,
 } from "./parseSimple";

packages/webdoc-parser/src/tag-parsers/parseSimple.js

@@ -11,6 +11,7 @@ import type {
   ExampleTag,
   LicenseTag,
   NameTag,
+  ReadonlyTag,
   SeeTag,
   SinceTag,
   ThrowsTag,
@@ -33,6 +34,8 @@ import {parseTypedDescription} from "./helper";
 // @todo <TODO>
 // @throws <ERROR_TYPE>
 // @type {TYPE}
+// @readonly
+// @readOnly
 // @see <URL | DOC_PATH>
 // @since <WHEN>
 
@@ -153,6 +156,15 @@ export function parseType(value: string, doc: $Shape<{ dataType?: ?DataType }>):
   };
 }
 
+export function parseReadonly(value: string, doc: $Shape<BaseDoc>): $Shape<ReadonlyTag> {
+  doc.readonly = true;
+
+  return {
+    value,
+    type: "ReadonlyTag",
+  };
+}
+
 export function parseSee(value: string, doc: $Shape<BaseDoc>): $Shape<SeeTag> {
   if (!doc.see) {
     doc.see = [];

packages/webdoc-parser/src/transformer/symbol-to-doc.js

@@ -32,6 +32,7 @@ import {
   parseProperty,
   parseProtected,
   parsePublic,
+  parseReadonly,
   parseReturn,
   parseScope,
   parseSee,
@@ -92,6 +93,8 @@ const TAG_PARSERS: { [id: string]: TagParser } = {
   "protected": parseProtected,
   "private": parsePrivate,
   "public": parsePublic,
+  "readOnly": parseReadonly,
+  "readonly": parseReadonly,
   "return": parseReturn,
   "returns": parseReturn, // alias @return
   "scope": parseScope,