Feat/member attributes - Githubissues

sphinx-contrib / matlabdomain

A Sphinx extension for documenting Matlab code

http://sphinxcontrib-matlabdomain.readthedocs.io/

Other

70 stars 45 forks source link

Feat/member attributes #83

Closed PekaryGergelyR closed 5 years ago

PekaryGergelyR commented 5 years ago

Created correct filter for private, protected, hidden and friend members #24 . Added option for enabling these:

private-members: Show all or the selected few
protected-members: Show all or the selected few
hidden-members: Show all or the selected few
friend-members: Show all or only those methods which are friend of selected meta classes

Fix bysource ordering #75 .

joeced commented 5 years ago

Thanks for the contribution. Could you make a test, that shows this code works as intended? For instance add a MATLAB class in tests/test_data that can be included in the tests/test_docs/index.rst, to at least visually check that it works.

PekaryGergelyR commented 5 years ago

I extended the existing method attribute tests and examples and added new ones for the property attributes and for the bysourceoption. Also I included the literal matlab code into thetest_docs\index.rst as well as I think it is much clearer that way, but I can remove it.

However, I am not sure the attribute parsing should be inside the filter_members method but I could not come up with a better place :/. This is my first contribution on github so please be considerate 😃.

joeced commented 5 years ago

Thanks for your addition. I'll look into it in the following days.