joeced
commented
6 years ago Just a few comments. In https://se.mathworks.com/help/matlab/matlab_oop/defining-properties.html and https://se.mathworks.com/help/matlab/matlab_oop/validate-property-values.html the notation for types on properties is a bit different than what you showed, but the end result is the same error.
classdef PropertiesWithType
% PROPERTIESWITHTYPE is a data type (class) for specific links.
%
% Args:
% link_name (string): Name of the reference link.
% pos (double, vector): Cartesian position of the link.
% rotm (double, matrix): (3 x 3) rotation matrix.
% idx (uint8, scalar): Index of the reference link.
properties
link_name string = 'none';
pos(3, 1) double = zeros(3,1);
rotm(3,3) double = eye(3,3);
idx uint8 = 0;
end
endRegarding the comment header, just keep a empty line between the docstring and the header like
function a = rot(b)
% Some docstring
%* Copyright header
% ...
%*
Ganimed
mikofski
Dear all,
In the last 3 Years Mathworks made a lot of changes and extensions for the Matlab-language, i.e. in OO-programming.
Currently I'm documenting my Matlab-Library for my thesis. In this library I needed to use very often the new (undocumented) syntax extensions to enforce the property types for the class property names. These new extensions are very helpful and makes the verification very easy if a property has the correct type. See following discussions below:
In general, the new syntax for the class properties is defined as follows:
For the
dimensionTypethere are three possible options, matrix, vector or scalar.I have made a very simple test class which has only properties. For example this simple class works in Sphinx with your latest matlabdomain very well:
But when I replace the above properties with
Then I will get following error from your parser:
Here is the full log:
Sphinx is with its plugins one of the best documentation tools, but unfortunately all current parser for documenting code in Matlab doesn't support this new syntax.
Is it possible to extend the parser with this new syntax s.t. Sphinx can interpret the new property syntax like below (in Google style with Napoleon)?
Or optional, which should be easier, is it possible that the new syntax right beside the property name will be ignored by the parser?
By the way, I have to set also a comment header into each file (copyright, license, etc.), like in C/C++:
% This is an Comment Header % Copyright (C) 2018, by John Doe. % % some descriptions ... % % lisence (GPL, BSD, etc.) %%
How is it possible, or how can I force, that the parser of the matlabdomain will ignore this comment header without raising any errors?
Thank you very much in advance!
With best regards, Ganimed.