Docblock

Latest version: v0.1.5

Safety actively analyzes 685670 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 3

0.0.5

Fixes an issue with parsing whitespace in operators.

0.0.4

This release:

- Allows matching on names like `::X`.
- Matches operator overloads of the form `operator<` etc.

0.0.3

Fixes an issue where docstrings were incorrectly stripped of (significant) whitespace.

0.0.2

Updates the README to include example usage.

0.0.1

Docblock

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 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.
> 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
shell
pip install docblock

0.0.1a2

Fix a parsing issue with function and method declarations.

Page 2 of 3

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.