doc: Remove attic classes from Doxygen #12795
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When attic modules are shown in the C++ documentation, there is noting that highlights them as legacy or to-be-deprecated so it is too easy for users to stuble into misleading information. (Note that for pydrake, attic code lives in the attic module so at least the information is segregated.)
|
+@EricCousineau-TRI +@sherm1 +@SeanCurtis-TRI for review, please. |
sherm1
reviewed
Mar 1, 2020
There was a problem hiding this comment.
Sweet!
Reviewed 1 of 1 files at r1.
Reviewable status: LGTM missing from assignees SeanCurtis-TRI(platform),EricCousineau-TRI(platform) (waiting on @EricCousineau-TRI and @SeanCurtis-TRI)
There was a problem hiding this comment.
Death to attic links!
Reviewed 1 of 1 files at r1.
Reviewable status: LGTM missing from assignee EricCousineau-TRI(platform) (waiting on @EricCousineau-TRI)
There was a problem hiding this comment.
Reviewed 1 of 1 files at r1.
Reviewable status:complete! all discussions resolved, LGTM from assignees SeanCurtis-TRI(platform),EricCousineau-TRI(platform),sherm1(platform)
jwnimmer-tri
added a commit
to jwnimmer-tri/drake
that referenced
this pull request
Mar 2, 2020
When attic modules are shown in the C++ documentation, there is noting that highlights them as legacy or to-be-deprecated so it is too easy for users to stumble into misleading information. (Note that for pydrake, attic code lives in the attic module so at least the information is segregated.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When attic modules are shown in the C++ documentation, there is noting that highlights them as legacy or to-be-deprecated so it is too easy for users to stumble into misleading information.
(Note that for pydrake, attic code lives in the attic module so at least the information is segregated.)
Relates #12158.
This change is