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

Interfaces documentation #280

Open
ncannasse opened this issue Feb 13, 2021 · 4 comments
Open

Interfaces documentation #280

ncannasse opened this issue Feb 13, 2021 · 4 comments

Comments

@ncannasse
Copy link
Member

Hi,

I noticed that interface fields are duplicated on the class implementation, see for instance interface here:
https://heaps.io/api/hxd/fs/FileSystem.html
and implementation there:
https://heaps.io/api/hxd/fs/BytesFileSystem.html

I think we should only list the methods/vars that have different signature - the way we do already with subclass overrides - as the implementation is most likely shared.

@Simn
Copy link
Member

Simn commented Feb 13, 2021

That seems questionable. The class has these methods and I don't see why the fact that one of its interfaces requires them would make them disappear from the documentation.

@Yanrishatum
Copy link

I don't think hiding them would be a good decision. However I would say that having an interface mark on those may be useful, as well as (if it's not already implemented) them inheriting the docs from interface if there's no customized documentation present.

@ncannasse
Copy link
Member Author

I mean we can hide them if they have no documentation.
It's exactly the same as we do for overriden methods so I don't see why we would not to this for implemented methods as well.

@ncannasse
Copy link
Member Author

I'm telling that from a documentation point of view : an interface is a specification, and the class implementing it respects this specification and most likely does not have any specific documentation to add compared to what's in the interface.

Another solution is to list them but with the interface documentation if the interface is documented and the the class isn't

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

No branches or pull requests

3 participants