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.

Sign up for GitHub

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

Jump to bottom

Constructed Classes need descriptions #156

Open
JessicaRehak opened this issue Mar 31, 2020 · 1 comment
Open

Constructed Classes need descriptions #156

JessicaRehak opened this issue Mar 31, 2020 · 1 comment

Comments

@JessicaRehak
Copy link
Collaborator

Many class interfaces need a std::string description() const method that returns a string describing the class. Any class that is the default implementation should have (default) at the beginning of the string.
@JessicaRehak JessicaRehak added the minor Isolated within in a single class or function. label Mar 31, 2020
@JessicaRehak
Copy link
Collaborator Author

A new utility class has been added bart::utility::HasDescription that has a description() method, that can be set using set_description(std::string). Default implementations can be set using is_default_implementation() that will add a (default) marker at the start of the string returned by description().

@JessicaRehak JessicaRehak removed the minor Isolated within in a single class or function. label Apr 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JessicaRehak