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

Document inherited declarations (whether via subclasses or default protocol implementations) #545

Closed
yeelan0319 opened this issue Apr 28, 2016 · 1 comment

Comments

@yeelan0319
Copy link

yeelan0319 commented Apr 28, 2016

Hi Jazzy team,

I want to ask for a feature that can generate document page for those classes that don't have their own method but purely inherit from their parent class.

For example, bar.h

#import "foo.h"

/**
This is a class that has a different implementation than their parent.
*/
@interface bar : foo
@end

Currently, Jazzy only provides an expandable box on the classes.html for classes like this and "docs/Classes/bar.html" doesn't exist. It is also true empty protocols. However, it is inconsistent from the other pages and seems broken for our documentation site.

I heard this feature used to be available in Doxygen and we have several classes/protocols like this, so we hope that Jazzy may consider also to generate a separate page for them.

Thanks!

@yeelan0319 yeelan0319 changed the title Provide document for classes have no own methods but purely inherit from their parent Generate documentation for empty subclasses/protocols Apr 28, 2016
yeelan0319 added a commit to material-components/material-components-ios that referenced this issue May 2, 2016
…pi reference with anchor tag link on summary page.

Relate issue: realm/jazzy#545
@jpsim jpsim changed the title Generate documentation for empty subclasses/protocols Document inherited declarations (whether via subclasses or default protocol implementations) May 19, 2016
@jpsim
Copy link
Collaborator

jpsim commented Jul 20, 2016

Closing as a duplicate of #190.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants