Add informational disclaimers to grammar files (FHIR#1399)

This partially addresses FHIR-42281.
Vermonster · Dec 18, 2023 · 1450d27 · 1450d27
1 parent a44195a
commit 1450d27
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/antlr/src/main/antlr/FSH.g4 b/antlr/src/main/antlr/FSH.g4
@@ -1,3 +1,9 @@
+/*
+ * FSH.g4: An ANTLR v4 parser representation of the FHIR Shorthand syntax, intended to be used with
+ * the corresponding FSHLexer.g4 lexer representation. This file is considered "informational"
+ * material in respect to the FSH specification. If there is a conflict between the FSH language
+ * specification and this file, the language specification takes precedence.
+ */
 grammar FSH;
 
 options { tokenVocab = FSHLexer; }

diff --git a/antlr/src/main/antlr/FSHLexer.g4 b/antlr/src/main/antlr/FSHLexer.g4
@@ -1,3 +1,9 @@
+/*
+ * FSHLexer.g4: An ANTLR v4 lexer representation of the FHIR Shorthand syntax, intended to be used
+ * with the corresponding FSH.g4 parser representation. This file is considered "informational"
+ * material in respect to the FSH specification. If there is a conflict between the FSH language
+ * specification and this file, the language specification takes precedence.
+ */
 lexer grammar FSHLexer;
 
 // KEYWORDS

diff --git a/antlr/src/main/antlr/MiniFSH.g4 b/antlr/src/main/antlr/MiniFSH.g4
@@ -1,3 +1,7 @@
+/*
+ * MiniFSH.g4: A minimal ANTLR v4 parser representation useful only in the context of certain
+ * functions within SUSHI. See FSH.g4 for a more complete FSH parser grammar.
+ */
 grammar MiniFSH;
 
 options { tokenVocab = MiniFSHLexer; }

diff --git a/antlr/src/main/antlr/MiniFSHLexer.g4 b/antlr/src/main/antlr/MiniFSHLexer.g4
@@ -1,3 +1,7 @@
+/*
+ * MiniFSHLexer.g4: A minimal ANTLR v4 lexer representation useful only in the context of certain
+ * functions within the SUSHI. See FSHLexer.g4 for a more complete FSH lexer grammar.
+ */
 lexer grammar MiniFSHLexer;
 
 STAR:               ([\r\n] | LINE_COMMENT) WS* '*' [ \u00A0];