Use simple documentation

Author: CoveMB

packages/core/stylus/src/contract.test.ts

@@ -80,7 +80,7 @@ test('contract with sorted traits', t => {
 
 test('contract with documentation', t => {
   const Foo = new ContractBuilder('Foo');
-  Foo.addDocumentationTag(`@custom:documentation`, 'some documentation');
+  Foo.addDocumentation('Some documentation');
   t.snapshot(printContract(Foo));
 });
 

packages/core/stylus/src/contract.test.ts.md

@@ -174,7 +174,7 @@ Generated by [AVA](https://avajs.dev).
 
     `// SPDX-License-Identifier: MIT␊
     // Compatible with OpenZeppelin Contracts for Stylus ^0.2.0-alpha.4␊
-    // @custom:documentation some documentation␊
+    //! Some documentation␊
     ␊
     #![cfg_attr(not(any(test, feature = "export-abi")), no_main)]␊
     extern crate alloc;␊

packages/core/stylus/src/contract.test.ts.snap

@@ -9,7 +9,7 @@ export interface Contract {
   license: string;
   securityContact: string;
   name: Name;
-  documentationTags: DocumentationTag[];
+  documentations: string[];
   useClauses: UseClause[];
   implementedTraits: ImplementedTrait[];
   constants: Variable[];
@@ -82,7 +82,7 @@ export class ContractBuilder implements Contract {
   license = 'MIT';
   securityContact = '';
 
-  readonly documentationTags: DocumentationTag[] = [];
+  readonly documentations: string[] = [];
 
   private implementedTraitsMap: Map<string, ImplementedTrait> = new Map();
   private useClausesMap: Map<string, UseClause> = new Map();
@@ -210,10 +210,8 @@ export class ContractBuilder implements Contract {
     existingFn.attribute = attribute;
   }
 
-  addDocumentationTag(key: string, value: string) {
-    // eslint-disable-next-line no-useless-escape
-    if (!/^(@custom:)?[a-z][a-z\-]*$/.exec(key)) throw new Error(`Invalid documentation key: ${key}`);
-    this.documentationTags.push({ key, value });
+  addDocumentation(description: string) {
+    this.documentations.push(description);
   }
 
   addSecurityTag(securityContact: string) {

packages/core/stylus/src/contract.ts

@@ -17,7 +17,7 @@ export function printContract(contract: Contract): string {
         `// SPDX-License-Identifier: ${contract.license}`,
         `// Compatible with OpenZeppelin Contracts for Stylus ${compatibleContractsSemver}`,
         ...(contract.securityContact ? ['', ...printSecurityTag(contract.securityContact)] : []),
-        ...printDocumentationTags(contract.documentationTags),
+        ...printDocumentation(contract.documentations),
       ],
       [`#![cfg_attr(not(any(test, feature = "export-abi")), no_main)]`, `extern crate alloc;`],
       spaceBetween(
@@ -287,8 +287,8 @@ function printArgument(arg: Argument): string {
   }
 }
 
-function printDocumentationTags(tags: DocumentationTag[]): string[] {
-  return tags.map(({ key, value }) => `// ${key} ${value}`);
+function printDocumentation(documentations: string[]): string[] {
+  return documentations.map(documentation => `//! ${documentation}`);
 }
 
 function printSecurityTag(securityContact: string) {