Skip to content

Commit

Permalink
Update README and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
N-Wouda committed Jul 20, 2023
1 parent bdb50a2 commit 3486bf6
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@
The `docblock` package reads and parses documentation from C++ header files.
It should also work out of the box for C header files, but that is currently untested.
It is opinionated and explicitly does *not* cover all edge cases of the C++ grammar, but hopes to provide sufficient utility for most use cases.
The package assumes documentation blocks are formatted as follows:
The package assumes documentation blocks are formatted using C-style comments, as follows:
```cpp
/**
* Text
*/
void func();
```
That is, the documentation block starts with `/*` or `/**`, and ends with `*/`.
Any starting `*` on documentation lines in the block are allowed, but not required.
Any starting `*` on documentation lines in the block are allowed, but not required.
> To avoid parsing issues, non-documentation block comments SHOULD NOT use C-style comments.
The `docblock` package is a pure Python package and depends only on `pyparsing`.
It can be installed as
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "docblock"
version = "0.0.1a0"
version = "0.0.1a1"
description = "Reads and parses documentation from header files in pure Python."
authors = ["Niels Wouda <nielswouda@gmail.com>"]
license = "MIT"
Expand Down

0 comments on commit 3486bf6

Please sign in to comment.