Common help entries for sub-classes in OO
in [Matlab]
|
Prev: Gaussian fit to histogram of image
Next: Plotting a linear trend line using "tools", "basic fitting"
From: Sam The Man on 10 Aug 2010 15:39 hi, I've got 1 base class, and a handful of sub-classes. These subclasses all implement a set of common functions, the functionality is different, but i'd like the help entries for all the functions to be the same. But the help entries go in the sub-class, where the implementation code is. I'd rather not cut and paste the help entries into each sub-class, is there a better way? thanks
From: Andy on 10 Aug 2010 15:51 "Sam The Man" <imnottelling(a)leavemealone.com> wrote in message <i3s9so$qim$1(a)fred.mathworks.com>... > hi, > > I've got 1 base class, and a handful of sub-classes. These subclasses all implement a set of common functions, the functionality is different, but i'd like the help entries for all the functions to be the same. But the help entries go in the sub-class, where the implementation code is. I'd rather not cut and paste the help entries into each sub-class, is there a better way? > > thanks Perhaps you should make a single package function instead?
From: Matt J on 10 Aug 2010 17:10 "Sam The Man" <imnottelling(a)leavemealone.com> wrote in message <i3s9so$qim$1(a)fred.mathworks.com>... > hi, > > I've got 1 base class, and a handful of sub-classes. These subclasses all implement a set of common functions, the functionality is different, but i'd like the help entries for all the functions to be the same. But the help entries go in the sub-class, where the implementation code is. I'd rather not cut and paste the help entries into each sub-class, is there a better way? ============ As a compromise, you could just put "See also BaseClass/Method" in the help text of every subclass. That would provide a direct html link to the base class help text, involve only a minimum of copy/paste, and would be robust to changes you make to the help text later or to the addition of new subclasses.
From: Sam The Man on 10 Aug 2010 22:56 "Matt J " <mattjacREMOVE(a)THISieee.spam> wrote in message <i3sf84$c8h$1(a)fred.mathworks.com>... > "Sam The Man" <imnottelling(a)leavemealone.com> wrote in message <i3s9so$qim$1(a)fred.mathworks.com>... > > hi, > > > > I've got 1 base class, and a handful of sub-classes. These subclasses all implement a set of common functions, the functionality is different, but i'd like the help entries for all the functions to be the same. But the help entries go in the sub-class, where the implementation code is. I'd rather not cut and paste the help entries into each sub-class, is there a better way? > ============ > > As a compromise, you could just put "See also BaseClass/Method" in the help text of every subclass. That would provide a direct html link to the base class help text, involve only a minimum of copy/paste, and would be robust to changes you make to the help text later or to the addition of new subclasses. The problem with this is, I don't seem to be able to give the abstract methods a help entry.
From: Matt J on 11 Aug 2010 10:38
"Sam The Man" <imnottelling(a)leavemealone.com> wrote in message <i3t3g4$cqk$1(a)fred.mathworks.com>... > The problem with this is, I don't seem to be able to give the abstract methods a help entry. =============== I see. Well, the best alternative I can think of is to write your own customized help function, call it say "myhelp", which knows to invoke the help for one particular subclass whenever the help for an arbitrary subclass is requested. |