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

Improve the class listing in "Subclassed by" #265

Open
jhlegarreta opened this issue Mar 21, 2021 · 0 comments
Open

Improve the class listing in "Subclassed by" #265

jhlegarreta opened this issue Mar 21, 2021 · 0 comments
Labels
type:Enhancement Improvement of existing methods or implementation

Comments

@jhlegarreta
Copy link
Member

jhlegarreta commented Mar 21, 2021

The list of classes that appears in the "Subclassed by" section of the examples contains a variable number of elements, depending on whether the class or classes demonstrated is/are a superclass of other classes. In some cases, this list can be very long, e.g.
https://itk.org/ITKExamples/src/Core/Common/FilterImage/Documentation.html, and the readability is low.

If possible, some changes might improve the readability and discoverability of the subclasses:

  • Avoid the template parameter list, or apply the nice formatting applied to the classes in the "Classes demonstrated" section.
  • Make the classes point to their corresponding Doxygen documentation. If not possible, maybe to examples demonstrating the classes if existing.
  • If the above are not possible, maybe we can change the whole section for a link to the class hierarchy that is displayed in the Doxygen pages.
  • By default, hide the list and just print "Subclassed by" which would expand when clicking.
@jhlegarreta jhlegarreta added the type:Enhancement Improvement of existing methods or implementation label Mar 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Enhancement Improvement of existing methods or implementation
Projects
None yet
Development

No branches or pull requests

1 participant