- Undocumented Matlab - https://undocumentedmatlab.com -
Types of undocumented Matlab aspects
Posted By Yair Altman On November 24, 2011 | No Comments
Why are there so many undocumented aspects in Matlab?
This is a great question, recently asked [1] by a reader of this blog, so I wanted to expand on it in next week’s article. Before specifying the different reasons, let’s map the nature of undocumented aspects that we find in Matlab.
The term undocumented/unsupported (as opposed to mis-documentated or deprecated) actually refers to quite a large number of different types.
In the following list, the hyperlinks on the list-item titles lead to a list of corresponding articles on this website:
function [tree, container] = uitree(varargin)
% WARNING: This feature is not supported in MATLAB
% and the API and functionality may change in a future release.
fix => %
% UITREE creates a uitree component with hierarchical data in a figure window.
% UITREE creates an empty uitree object with default property values in
% a figure window.
%...
These functions are not documented in the full documentation (via Matlab’s doc function, or online). The odd thing is that some of these functions may appear in the category help output (for example, help(‘uitools’)), and in some cases may even have a fully-visible help section (e.g., help(‘setptr’)), but do not have any online help documentation (docsearch(‘setptr’) fails, and doc(‘setptr’) simply displays the readable help text).
All these functions are officially unsupported by MathWorks, even when having a readable help section. The rule of thumb appears to be that a Matlab function is supported only if it has online documentation. Note, however, that in some rare cases a documentation discrepancy may be due to a MathWorks documentation error, not to unsupportability…
Next week I will list the reasons that cause MathWorks to decide whether a particular feature or property should be documented or not.
Categories: High risk of breaking in future versions, Java, Low risk of breaking in future versions, Medium risk of breaking in future versions, Semi-documented feature, Semi-documented function, Undocumented feature, Undocumented function
Article printed from Undocumented Matlab: https://undocumentedmatlab.com
URL to article: https://undocumentedmatlab.com/articles/types-of-undocumented-matlab-aspects
URLs in this post:
[1] asked: http://undocumentedmatlab.com/blog/guide-customization/#comment-61578
[2] Undocumented functions: http://undocumentedmatlab.com/blog/tag/undocumented-function/
[3] MEX: http://undocumentedmatlab.com/blog/category/mex/
[4] Semi-documented functions: http://undocumentedmatlab.com/blog/tag/semi-documented-function/
[5] Undocumented features: http://undocumentedmatlab.com/blog/tag/undocumented-feature/
[6] properties: http://undocumentedmatlab.com/blog/tag/undocumented-property/
[7] Semi-documented features: http://undocumentedmatlab.com/blog/tag/semi-documented-feature/
[8] article: http://undocumentedmatlab.com/blog/getundoc-get-undocumented-object-properties/
[9] Internal Matlab classes: http://undocumentedmatlab.com/blog/tag/internal-component/
[10] Matlab-Java integration: http://undocumentedmatlab.com/blog/tag/JMI
[11] Matlab’s UDD mechanism: http://undocumentedmatlab.com/?s=UDD
[12] Reasons for undocumented Matlab aspects : https://undocumentedmatlab.com/articles/reasons-for-undocumented-matlab-aspects
[13] Undocumented plot marker types : https://undocumentedmatlab.com/articles/undocumented-plot-marker-types
[14] Setting class property types – take 2 : https://undocumentedmatlab.com/articles/setting-class-property-types-2
[15] Setting class property types : https://undocumentedmatlab.com/articles/setting-class-property-types
[16] uiundo – Matlab's undocumented undo/redo manager : https://undocumentedmatlab.com/articles/uiundo-matlab-undocumented-undo-redo-manager
[17] Undocumented Matlab MEX API : https://undocumentedmatlab.com/articles/undocumented-matlab-mex-api
Click here to print.
Copyright © Yair Altman - Undocumented Matlab. All rights reserved.