Skip to content

Commit

Permalink
Standardized the header over all file types
Browse files Browse the repository at this point in the history
  • Loading branch information
Thierry Delafontaine committed Jul 20, 2022
1 parent 57f6cee commit 3044730
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 58 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ All notable changes to the "zhaw-snippets" extension will be documented in this
### 1.0.5

- Updated the python header, to match common usage
- Standardized the header over all file types
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,4 @@ Users appreciate release notes as you update your extension.
### 1.0.5

- Updated the python header, to match common usage
- Standardized the header over all file types
22 changes: 11 additions & 11 deletions snippets/c.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
"InES Header": {
"prefix": "inesh",
"body": [
"${BLOCK_COMMENT_START}*------------------------------------------------------------------",
" * -- _____ ______ _____ --",
" * -- |_ _| | ____|/ ____| --",
" * -- | | _ __ | |__ | (___ Institute of Embedded Systems --",
" * -- | | | '_ \\\\| __| \\___ \\ Zurich University of --",
" * -- _| |_| | | | |____ ____) | Applied Sciences --",
" * -- |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland --",
" * ------------------------------------------------------------------",
"${BLOCK_COMMENT_START} ============================================================",
" * _____ ______ _____",
" * |_ _| | ____|/ ____|",
" * | | _ __ | |__ | (___ Institute of Embedded Systems",
" * | | | '_ \\\\| __| \\___ \\ Zurich University of",
" * _| |_| | | | |____ ____) | Applied Sciences",
" * |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland",
" * ============================================================",
" * @file ${TM_FILENAME}",
" * @author ${1:<author>} <${2:<email>}@zhaw.ch>",
" * @author ${1:<author>} (${2:<initials>}@zhaw.ch)",
" * @copyright ${CURRENT_YEAR} ZHAW Institute of Embedded Systems",
" * @date ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
" * @brief ${3:<brief description>}",
" *",
" * ${4}",
" * ------------------------------------------------------------------",
" * ${4:<extensive description>}",
" * ============================================================",
" ${BLOCK_COMMENT_END}",
"",
"$0"
Expand Down
22 changes: 11 additions & 11 deletions snippets/cpp.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
"InES Header": {
"prefix": "inesh",
"body": [
"${BLOCK_COMMENT_START}*------------------------------------------------------------------",
" * -- _____ ______ _____ --",
" * -- |_ _| | ____|/ ____| --",
" * -- | | _ __ | |__ | (___ Institute of Embedded Systems --",
" * -- | | | '_ \\\\| __| \\___ \\ Zurich University of --",
" * -- _| |_| | | | |____ ____) | Applied Sciences --",
" * -- |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland --",
" * ------------------------------------------------------------------",
"${BLOCK_COMMENT_START} ============================================================",
" * _____ ______ _____",
" * |_ _| | ____|/ ____|",
" * | | _ __ | |__ | (___ Institute of Embedded Systems",
" * | | | '_ \\\\| __| \\___ \\ Zurich University of",
" * _| |_| | | | |____ ____) | Applied Sciences",
" * |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland",
" * ============================================================",
" * @file ${TM_FILENAME}",
" * @author ${1:<author>} <${2:<email>}@zhaw.ch>",
" * @author ${1:<author>} (${2:<initials>}@zhaw.ch)",
" * @copyright ${CURRENT_YEAR} ZHAW Institute of Embedded Systems",
" * @date ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
" * @brief ${3:<brief description>}",
" *",
" * ${4}",
" * ------------------------------------------------------------------",
" * ${4:<extensive description>}",
" * ============================================================",
" ${BLOCK_COMMENT_END}",
"",
"$0"
Expand Down
16 changes: 8 additions & 8 deletions snippets/latex.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"zhawh": {
"prefix": "inesh",
"body": [
"% ------------------------------------------------------------------",
"% -- _____ ______ _____ --",
"% -- |_ _| | ____|/ ____| --",
"% -- | | _ __ | |__ | (___ Institute of Embedded Systems --",
"% -- | | | '_ \\\\| __| \\___ \\ Zurich University of --",
"% -- _| |_| | | | |____ ____) | Applied Sciences --",
"% -- |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland --",
"% ------------------------------------------------------------------",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT} _____ ______ _____",
"${LINE_COMMENT} |_ _| | ____|/ ____|",
"${LINE_COMMENT} | | _ __ | |__ | (___ Institute of Embedded Systems",
"${LINE_COMMENT} | | | '_ \\\\| __| \\___ \\ Zurich University of",
"${LINE_COMMENT} _| |_| | | | |____ ____) | Applied Sciences",
"${LINE_COMMENT} |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland",
"${LINE_COMMENT} ============================================================",
"",
"$0"
],
Expand Down
2 changes: 1 addition & 1 deletion snippets/python.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"body": [
"${1:#!/usr/bin/env python}",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT} _____ ______ _____ ",
"${LINE_COMMENT} _____ ______ _____",
"${LINE_COMMENT} |_ _| | ____|/ ____|",
"${LINE_COMMENT} | | _ __ | |__ | (___ Institute of Embedded Systems",
"${LINE_COMMENT} | | | '_ \\\\| __| \\___ \\ Zurich University of",
Expand Down
22 changes: 11 additions & 11 deletions snippets/shell.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
"prefix": "inesh",
"body": [
"${1|#!/bin/sh,#!/bin/bash,#!/bin/fish,#!/bin/zsh|}",
"${LINE_COMMENT}#################################################################",
"${LINE_COMMENT}# _____ ______ _____ ##",
"${LINE_COMMENT}# |_ _| | ____|/ ____| ##",
"${LINE_COMMENT}# | | _ __ | |__ | (___ Institute of Embedded Systems ##",
"${LINE_COMMENT}# | | | '_ \\\\| __| \\___ \\ Zurich University of ##",
"${LINE_COMMENT}# _| |_| | | | |____ ____) | Applied Sciences ##",
"${LINE_COMMENT}# |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland ##",
"${LINE_COMMENT}#################################################################",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT} _____ ______ _____",
"${LINE_COMMENT} |_ _| | ____|/ ____|",
"${LINE_COMMENT} | | _ __ | |__ | (___ Institute of Embedded Systems",
"${LINE_COMMENT} | | | '_ \\\\| __| \\___ \\ Zurich University of",
"${LINE_COMMENT} _| |_| | | | |____ ____) | Applied Sciences",
"${LINE_COMMENT} |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT} File: ${TM_FILENAME}",
"${LINE_COMMENT} Author: ${2:<author>} <${3:<email>}@zhaw.ch>",
"${LINE_COMMENT} Author: ${2:<author>} (${3:<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: ${4:<brief description>}",
"${LINE_COMMENT} ",
"${LINE_COMMENT} ${5}",
"${LINE_COMMENT}#################################################################",
"${LINE_COMMENT} ${5:<extensive description>}",
"${LINE_COMMENT} ============================================================",
"",
"$0"
],
Expand Down
32 changes: 16 additions & 16 deletions snippets/vhdl.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@
"InES Header": {
"prefix": "inesh",
"body": [
"-- ------------------------------------------------------------------",
"-- -- _____ ______ _____ --",
"-- -- |_ _| | ____|/ ____| --",
"-- -- | | _ __ | |__ | (___ Institute of Embedded Systems --",
"-- -- | | | '_ \\\\| __| \\___ \\ Zurich University of --",
"-- -- _| |_| | | | |____ ____) | Applied Sciences --",
"-- -- |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland --",
"-- ------------------------------------------------------------------",
"--! @file ${TM_FILENAME}",
"--! @author ${1:<author>} <${2:<email>}@zhaw.ch>",
"--! @copyright ${CURRENT_YEAR} ZHAW Institute of Embedded Systems",
"--! @date ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
"--! @brief ${3:<brief description>}",
"--!",
"--! ${4}",
"---------------------------------------------------------------------",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT} _____ ______ _____",
"${LINE_COMMENT} |_ _| | ____|/ ____|",
"${LINE_COMMENT} | | _ __ | |__ | (___ Institute of Embedded Systems",
"${LINE_COMMENT} | | | '_ \\\\| __| \\___ \\ Zurich University of",
"${LINE_COMMENT} _| |_| | | | |____ ____) | Applied Sciences",
"${LINE_COMMENT} |_____|_| |_|______|_____/ 8401 Winterthur, Switzerland",
"${LINE_COMMENT} ============================================================",
"${LINE_COMMENT}! @file ${TM_FILENAME}",
"${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"
],
Expand Down

0 comments on commit 3044730

Please sign in to comment.