Problem when documenting multiple Matlab classes

[sphinx-contrib]

Problem when documenting multiple Matlab classes

[joeced]

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

---

fixes #23 and fixes #35

• skip methods defined in separate files

[joeced]

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

---

fixes #23 and fixes #35

• skip methods defined in separate files

[joeced]

Original comment by Sandor Toth (Bitbucket: tothsa, GitHub: Unknown):

---

Thank you for the help! I realised that when a class is in a @classname folder, it has to added as a module and all class methods in the @classname folder become functions. Is there a way to document the methods of @classname class as methods?

[joeced]

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

---

according to matlab docs on methods in separate folders you only need to use a method signature if it is a non-default method:

If you want to use nondefault method attributes for a method implemented in a separate file, you must add the function signature to a methods block with the attribute specification.

IE: like a static method or has any method attributes. Then it won't work with autodoc extension until we tell it to skip those signatures.

[joeced]

Original comment by Mark Mikofski (Bitbucket: bwanamarko, GitHub: Unknown):

---

You should be able to document class @ folders, see this example from the test data however if you look at the comments in #21 you'll see that the method protocols in the class m-file don't match any protocol that Pygments (the syntax lexer that parses matlab files) recognizes, so someone need to add a regex to the MatObject.parse_mfile method on line 157 of mat_types that ignores function protocols in classdef mfiles when the actual method is in a separate file.