[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: classdef is pretty good now (inputParser implemented in core). What

From: Richard Crozier
Subject: Re: classdef is pretty good now (inputParser implemented in core). What now? How to document classdef classes?
Date: Thu, 21 Aug 2014 20:48:26 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.0

On 21/08/14 15:23, Carnë Draug wrote:

I have implemented what I believe to be the first classdef class for
Octave [1]. Kudos to Michael Goffioul for working on it. It seems to
work well for inputParser which opens a whole lot of low-hanging
"classdef" fruits that can now be implemented in Octave. I'll guess we
should start implementing those so we can test classdef.

But one the things that is also needed, is a way to document this
classes? 'help classname' will work fine but only give the first help
text block (constructor?) but what about its other methods? Using
'help class.method' will give nothing. And print_usage() does not yet
work from within methods and how will it? Should we have a giant help
text block at the start or can we somehow start having the help next
to the methods and properties? Matlab seems to create it from
multiple comments through the file, doxygen and javadoc style [2].

Also, we need a consensus for the names used on the @deftypefn
macros when using classdef, as they're not function files anymore.


[1] http://hg.savannah.gnu.org/hgweb/octave/rev/ff820f92cbb5

I have been testing classdef for a while now, and am also grateful for all the work that's gone into it. However, with the Octave build I'm, using, you cannot set a debug break point in a class method. If this isn't already implemented, I think it would be important to do so quickly if people are going to start adding classdef classes to Octave core.


The University of Edinburgh is a charitable body, registered in
Scotland, with registration number SC005336.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]