|
| From: | John W. Eaton |
| Subject: | Re: documentation style question |
| Date: | Fri, 12 Sep 2014 11:57:10 -0400 |
| User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Icedove/24.5.0 |
On 09/12/2014 11:50 AM, Michael Godfrey wrote:
Would something like:
## @deftypefn {Command} {} grid
## @deftypefnx {Command} {} grid [ on | off ]
## @deftypefnx {Command} {} grid minor [ on | off ]
## @deftypefnx {Function File} {} grid (@var{hax}, @dots{})
(and if there is a default in the [ ] list indicate it with {x} as is
done in the display of graphics figure properties )
to make things more compact?
Yes, but then people get confused about the meaning of the "[", "|", and "]" characters because they are part of Octave's syntax.
jwe
| [Prev in Thread] | Current Thread | [Next in Thread] |