Skip to content

Commit

Permalink
Apply markdownlint
Browse files Browse the repository at this point in the history
  • Loading branch information
AkiraMiyakoda committed Jun 28, 2023
1 parent 11f0ea7 commit 5913e08
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Insert C/C++ Include Guard Macros

![GitHub](https://img.shields.io/github/license/AkiraMiyakoda/cppIncludeGuard)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/2a44d966d64d4dd78c4a03df2cbb13de)](https://app.codacy.com/gh/AkiraMiyakoda/cppIncludeGuard/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
![Visual Studio Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/akiramiyakoda.cppincludeguard)
![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/akiramiyakoda.cppincludeguard)
![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/akiramiyakoda.cppincludeguard)

# Insert C/C++ Include Guard Macros

The **C/C++ Include Guard** extension enables you to add, remove or update [include guard macros](https://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Include_Guard_Macro) to your C/C++ header files in one go.

Thanks to contributors: **@erkan-ozkan**, **@HO-COOH**, **@sleiner**, **@Philanatidae**, **@alexolog**

## Screenshots

Automatically insert include guard when creating a new header file

![Automatic Insert](images/auto-insert.gif)


Insert and Remove include guard

![Insert and Remove](https://github.com/AkiraMiyakoda/cppIncludeGuard/raw/master/images/insert-remove.gif)
Expand All @@ -30,7 +30,7 @@ Automatically update include guard when renaming a header file

## Features

* Generates include guard macros from GUID (or UUID v4), file name or file path. All non-alphanumeric characters are replaced with underscores.
- Generates include guard macros from GUID (or UUID v4), file name or file path. All non-alphanumeric characters are replaced with underscores.

```C
// GUID
Expand All @@ -41,7 +41,7 @@ Automatically update include guard when renaming a header file
#define FOO_BAR_UTILS_H
```

* Selectable comment style on ```#endif```. Block, line or none.
- Selectable comment style on `#endif`. Block, line or none.

```C
/* Block comment. */
Expand All @@ -54,42 +54,42 @@ Automatically update include guard when renaming a header file
#endif
```

* Prevents GUIDs from starting with a decimal number. (Optional)
- Prevents GUIDs from starting with a decimal number. (Optional)

```C
// Can prevent ill-formed macros like this.
#define 47A7840C_D31B_4D39_BF77_E5E957F0A97A
```

* Adds a cusomizable prefix and/or suffix. (Optional)
- Adds a cusomizable prefix and/or suffix. (Optional)

```C
#define ABC_7FE87DA8_601D_4D8E_AEE5_E6BE6EAB5678_XYZ
```

* Shortens redundant underscores. (Optional)
- Shortens redundant underscores. (Optional)

```C
// From a path like 'foo/_bar_/utils.h'.
#define FOO_BAR_UTILS_H // not FOO__BAR__UTILS_H
```

* Removes the file extension. (Optional)
- Removes the file extension. (Optional)

```C
// From a path like 'foo/bar/utils.h'.
#define FOO_BAR_UTILS
```

* Selectable number of folders which should be used for include guard. (Optional)
- Selectable number of folders which should be used for include guard. (Optional)

```C
// From a path like 'foo/bar/utils.h'.
#define BAR_UTILS
```

* Skips comment blocks at the beginning of a file. (Optional)
* Inserts a blank line after the first comment blocks. (Optional)
- Skips comment blocks at the beginning of a file. (Optional)
- Inserts a blank line after the first comment blocks. (Optional)

```C
/**
Expand All @@ -103,6 +103,6 @@ Automatically update include guard when renaming a header file
#define FOO_BAR_UTILS_H
```
* Removes #pragma once when an include guard is added. (Optional)
- Removes #pragma once when an include guard is added. (Optional)
* Customizable number of spaces between ```#endif``` and its comment.
- Customizable number of spaces between `#endif` and its comment.

0 comments on commit 5913e08

Please sign in to comment.