Add class annotation to HTML templates for different kinds of entities #1929
Conversation
This file contains hidden or 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
…s so that tools like Dashing can search for them.
|
See dashing.json for an example configuration file for Dashing to see what I mean. |
xster
reviewed
Feb 8, 2019
| @@ -8,7 +8,7 @@ <h5>{{parent.name}} {{parent.kind}}</h5> | |||
|
|
|||
| <div id="dartdoc-main-content" class="col-xs-12 col-sm-9 col-md-8 main-content"> | |||
| {{#self}} | |||
| <div>{{>source_link}}<h1>{{{nameWithGenerics}}} {{kind}} {{>categorization}}</h1></div> | |||
| <div>{{>source_link}}<h1><span class="kind-typedef">{{{nameWithGenerics}}}</span> {{kind}} {{>categorization}}</h1></div> | |||
There was a problem hiding this comment.
I was making it match the other templates... I'll make them all match: I think they need the indent because the {{#self}} wraps it with tags.
|
LGTM. #1932 should address the test failure. |
jcollins-g
approved these changes
Feb 11, 2019
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.
Tools like Dashing (used to create offline docs for Dash/Zeal) use CSS descriptors to index the different entities so that they can search for them and display them in a menu. Since the library and class types now use the same CSS in dartdoc, that made it impossible to differentiate between libraries and classes.
This PR adds some (empty) CSS classes in spans around the names of the entities, so that it's easy to explicitly find the name of the entity for each type in the HTML output.
I didn't use the
{{kind}}template parameter because it sometimes contains spaces.Addresses flutter/flutter#27654