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

Method documentation is missing the "param" comments #29

Open
Fydar opened this issue Feb 17, 2020 · 0 comments
Open

Method documentation is missing the "param" comments #29

Fydar opened this issue Feb 17, 2020 · 0 comments
Assignees
Labels
📝 documentation Improvements or additions to documentation

Comments

@Fydar
Copy link
Owner

Fydar commented Feb 17, 2020

The XML documentation inline with code contains documentation for parameters. However; the HTML documentation doesn't include these.

An example of a method in the documentation can be found here: https://fydar.github.io/AssetIcons/Documentation#RenderCache_GetTexture

Expected Result

The description about each parameter would be best placed in a table on the method pages in the documentation.

Constructors don't have their own pages at the moment, so there isn't anywhere go put these parameter comments on constructors without causing too much noise.

@Fydar Fydar added the 📝 documentation Improvements or additions to documentation label Feb 17, 2020
@Fydar Fydar self-assigned this Feb 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant