MATLAB Answers

Setting the Description and DetailedDescription attributes of MATLAB classes

2 views (last 30 days)
Sam Roberts
Sam Roberts on 11 Dec 2012
Built-in MATLAB classes have values for a Description and DetailedDescription attribute:
>> ?handle
ans =
meta.class handle
Package: meta
Properties:
Name: 'handle'
Description: 'Base class for handle classes'
DetailedDescription: ''
[snip]
Similarly, some methods and properties of built-in classes have the same attributes:
>> a = ?containers.Map;
>> a.PropertyList(1)
ans =
meta.property handle
Package: meta
Properties:
Name: 'Count'
Description: 'Number of pairs in the collection'
DetailedDescription: ''
[snip]
How can I set these attributes for my classes/methods/properties?

  0 Comments

Sign in to comment.

Answers (1)

Rowland
Rowland on 11 Dec 2012
It looks like the Description and DetailedDescription properties are not being used yet.

  1 Comment

Sam Roberts
Sam Roberts on 12 Dec 2012
Well, yes I know the documentation says that - except they are being used, as shown in the examples above. You may be right, in that there may be no way currently for a user to set them, but MATLAB itself is setting them somehow. I'm wondering whether it's possible for a user to do that, even in an undocumented way.

Sign in to comment.

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!