fix(vhdl): remove the brief and detailed description from the header …

…because doxygen expects the entity description before the entity declaration
InES-HPMM · Feb 10, 2023 · c8521e8 · c8521e8
1 parent 9e1cae7
commit c8521e8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,3 +42,5 @@ All notable changes to the "zhaw-snippets" extension will be documented in this
 
 - fix(vhdl): add escape character before @zhaw to escape the @ symbol (conflict
   with doxygen commands)
+- fix(vhdl): remove the brief and detailed description from the header because
+  doxygen expects the entity description before the entity declaration
diff --git a/snippets/vhdl.json b/snippets/vhdl.json
@@ -14,9 +14,6 @@
       "${LINE_COMMENT}! @author ${1:<author>} (${2:<initials>}\\@zhaw.ch)",
       "${LINE_COMMENT}! @copyright ${CURRENT_YEAR} ZHAW Institute of Embedded Systems",
       "${LINE_COMMENT}! @date ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
-      "${LINE_COMMENT}! @brief ${3:<brief description>}",
-      "${LINE_COMMENT}!",
-      "${LINE_COMMENT}! ${4:<extensive description>}",
       "${LINE_COMMENT} ============================================================",
       "",
       "$0"