Can Matlab compiler pass the summary of functions?

When I build .Net assemly from C# source codes, the summary of functions, which is represented by xml comments, can be seen via "Objet Browser" in Visual Studio.

Is it possible to see the summary of Matlab functions, which is compiled by mcc command, in "Objet Browser", like C#?

If possible, please let me know how to realize.

Answer 1

[Kojiro Saito]

This way is not documented, but there's a way to create function summaries to your dll.

Go to Apps -> Library Compiler and select .NET assembly and package functions, MATLAB Compiler SDK will create document XML files in for_testing folder. In this example, MagicSquareComp.xml will be created in for_testing folder. This XML file contains summary tags. Copy this XML file to your dll (For example, MagicSquareComp.dll) which was added to reference in your Visual Studio solution file. After that, you will find summary information is added in Object Browser.

You can edit the XML file so as to change the descriptions. You might need to restart Visual Studio to refresh the display of Object Browser.

Hope this help.

[Yoshihiro Yamada]

Thank you so much for your kind advice.

The generated xml file made possible to browse function headers via object browser.

However, I have come up with an additional question. The sentense I wrote appears only in remarks tags. If possible I'd like to specify the contents of &ltsummary&gt or &ltparam name&gt tags.

[Kojiro Saito]

Do you mean you want to specify '<summary>' and '<param>' in function definition? It's also possible by editing the XML.

Before

After edited

[michio]

[Note: The following is a comment from Yoshihiro Yamada at 16:40 2018/01/26, the original was deleted.]

Sorry for my ambiguous question. I wonder if I can change the contents of &ltsummary&gt or &ltparam name&gt by editing headers in Matlab source code. In other words, can I synchronize xml file with the header?

[Kojiro Saito]

I think comments in the original MATLAB function will be converted to &ltremarks&gt tag in XML. But &ltparam&gt and &ltreturns&gt tags will be created if the MATLAB function has input arguments and output. So, you can edit the XML file manually.

[Yoshihiro Yamada]

Comparing to the current situations, it will be much convinient that I can browse the Matlab header contents via object browser.

Thank you for your suggestions!