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

Make sure all elements get validated/updated #55

Merged
merged 8 commits into from
Mar 10, 2020

Conversation

baheath
Copy link
Collaborator

@baheath baheath commented Mar 6, 2020

Make sure all elements get validated/updated.

Before, many elements generated as part of the non-editable documentation weren't checked during yaml emit. This meant that many elements of Hyde documentation that have changed over time or where the header declarations changed were never updated in existing documentation. Also, extraneous elements were never removed from many elements.

Also:

  • Renamed defined-in-file element for consistency
  • Escape newlines in notification strings
  • Added namespace element to everything except class members

- Use underscore for multi-word keys
- Make sure removed keys are handled properly
- Reenable annotation and tags elements
- Differentiate annotation for explicitly defaulted vs implicitly (compiler) defaulted members
- Differentiate annotation for explicitly deleted vs implicitly (compiler) deleted members
…nerated. Ensure all expected elements are checked.
Copy link
Contributor

@fosterbrereton fosterbrereton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks for this solid contribution!

@@ -442,8 +675,13 @@ bool yaml_base_emitter::check_object_array(const std::string& filepath,
};

if (!expected_node.count(key)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check looks like it could be generalized into a routine and called from the multiple check_* APIs.

@fosterbrereton fosterbrereton merged commit 37d4bbc into master Mar 10, 2020
@fosterbrereton fosterbrereton deleted the bheath/annotations branch March 10, 2020 16:59
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

Successfully merging this pull request may close these issues.

None yet

3 participants