Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Doxygen comments #14

Open
lczech opened this issue Feb 26, 2017 · 0 comments
Open

Minor: Doxygen comments #14

lczech opened this issue Feb 26, 2017 · 0 comments

Comments

@lczech
Copy link

lczech commented Feb 26, 2017

Most of my functions and classes are documented with Doxygen-style comments, e.g.

/**
 * @brief Stream interface for reading data from an @link BaseInputSource InputSource@endlink,
 * that keeps track of line and column counters.
 *
 * This class provides...
 */

Binder generates this doc string:

"Stream interface for reading data from an \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"

It is cool that Binder actually takes care of "binding" the documentation, too! However, it seems to break at @... directives other than @brief. Maybe, it is not an important feature to fix, because being able to process Doxygen directives might be too much, So in the future, I might work on this in a fork, but for completeness, I wanted to report it here, too, and get your opinion on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant