https://github.com/tdegeus/cpp_comment_format

Formatting comment blocks
https://github.com/tdegeus/cpp_comment_format

Last synced: 11 days ago
JSON representation

Formatting comment blocks

• Host: GitHub
• URL: https://github.com/tdegeus/cpp_comment_format
• Owner: tdegeus
• License: mit
• Created: 2022-10-16T14:33:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-14T17:21:28.000Z (9 months ago)
• Last Synced: 2024-04-16T06:53:11.877Z (7 months ago)
• Language: Python
• Size: 52.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cpp_comment_format

Format code blocks.

## From command line

Default style, print result to screen:

```bash

cpp_comment_format example.cpp

```

To modify in place:

```bash

cpp_comment_format -i example.cpp

```

Using a specific style:

```bash

cpp_comment_format --style "javadoc" --doxygen "@" example.cpp

```

## Using pre-commit

Default style:

```yaml

repos:

- repo: https://github.com/tdegeus/cpp_comment_format

  rev: v0.0.2

  hooks:

  - id: cpp_comment_format

```

Using a specific style:

```yaml

repos:

- repo: https://github.com/tdegeus/cpp_comment_format

  rev: v0.0.2

  hooks:

  - id: cpp_comment_format

    args: ["--style", "javadoc", "--doxygen", "@"]

```