GithubHelp home page GithubHelp logo

n-wouda / docblock Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 39 KB

Parse C++ documentation blocks using Python.

License: MIT License

Python 100.00%
comment-parser cpp documentation-tool python c

docblock's Introduction

Hi, I'm Niels! ๐Ÿ‘‹

I like to write software tools that help humans make better decisions. Check out the repositories below to see some of my work!

docblock's People

Contributors

n-wouda avatar

Stargazers

 avatar  avatar

Watchers

 avatar

docblock's Issues

Aligned structs or classes are not understood

Describe the bug

Currently, the following C++ snippet is not parsed correctly.
This is due to the alignas(16) in between class and Foo, which docblock does not understand.

Code sample

class alignas(16) Foo
{
  /**
   * A documentation block describing Foo::bar.
   */
  int bar();
}

Note: Please be sure you are using the latest released version of docblock, or a recent build of main.
If your problem has been fixed in an unreleased version, you might be able to use main until a new release occurs.

Note: If you are using a released version, have you verified that the bug exists in the main branch of this repository?

If the issue has not been resolved, please file it in the issue tracker.
Make sure to include the version of Python you are using, and the version of docblock you run.
You can copy-paste the output of import docblock; docblock.show_versions() to achieve this.

Expected Output

A clear and concise description of what you expected to happen.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.