How to access subfunction headers with "help" command?

2 views (last 30 days)
Hallo userbase,
for the following situation, is it possible to print the subfunction header to the command window using help?
function foo = myFunc(bar)
%MYFUNC
% A pointless function to demonstrate my question.
% @param <bar> input var
% @return <foo> output var
foo = mySubFunc(bar);
end % END myFunc
function foo = mySubFunc(bar)
%MYFUNC.MYSUBFUNC
% Here is some information about my very important and refactored subfunction.
foo = bar + bar;
end % END mySubFunc
If I punch in help myFunc :
>> help myFunc
myFunc
A pointless function to demonstrate my question.
@param <bar> input var
@return <foo> output var
But is there some way to access the subfunction header? Something like help myFunc.mySubFunc?
All the best, Marshall

Accepted Answer

Adam
Adam on 14 Nov 2014
I'm fairly sure you can't. The subfunction is private to the file it is in so it has no outside visibility and shouldn't need it either since it cannot be called from outside of its parent file.
  2 Comments
Marshall
Marshall on 25 Nov 2014
Huh, that's weird. Thanks for the reply!
I really thought I read something somewhere, or had done something. Must have been dreaming in code again...
Image Analyst
Image Analyst on 10 Jan 2015
I guess you'd need to make it a comment for it to appear, just like the other comments appear:
% function foo = mySubFunc(bar)

Sign in to comment.

More Answers (1)

per isakson
per isakson on 10 Jan 2015
Edited: per isakson on 12 Jan 2015
"Something like help myFunc.mySubFunc?" &nbsp Yes, it's possible with R2013a (and earlier). Try
>> help cssm>sub_cssm
sub_cssm - subfunction of cssm
where
function cssm
end
function sub_cssm
% sub_cssm - subfunction of cssm
end

Categories

Find more on Scripts in Help Center and File Exchange

Community Treasure Hunt

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

Start Hunting!