[Matlab] Add basic Feature documentation

Author: mpsonntag

+nix/Feature.m

@@ -1,3 +1,35 @@
+% nix.Feature class provides additional functionality to nix.Tag and nix.MultiTag.
+%
+% Features are created from a nix.Tag or a nix.MultiTag, linking these to an
+% additional nix.DataArray. The way how data from the respective DataArray
+% and the Tag/MultiTag are connected, is specified by the nix.LinkType of
+% the associated nix.Feature.
+%
+% nix.Property properties:
+%   id (char):                read-only, automatically created id of the entity.
+%   linkType (nix.LinkType):  see nix.LinkType description below.
+%
+% nix.LinkType.Tagged
+%   This LinkType indicates, that the position and extent will be applied also 
+%   to the data stored via the Feature when it is fetched via the Tag/MultiTag.
+%
+% nix.LinkType.Untagged
+%   This implies that the whole data stored in the linked DataArray belongs to
+%   the Feature.
+%
+% nix.LinkType.Indexed
+%   This LinkType is only valid for MultiTags where it indicates that the data linked 
+%   via this Feature has to be accessed according to the index in the respective 
+%   MulitTag position entry.
+%
+% Examples:  %-- Returns the Features LinkType.
+%            lt = currFeature.linkType();
+%            %-- Sets the Feature LinkType. Has to be a valid nix.LinkType.
+%            currFeature.linkType(nix.LinkType.Tagged);
+%
+% See also nix.LinkType, nix.DataArray, nix.Tag, nix.MultiTag.
+%
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,11 +39,9 @@
 % LICENSE file in the root of the Project.
 
 classdef Feature < nix.Entity
-    % Feature nix Feature object
 
     properties (Hidden)
-        % namespace reference for nix-mx functions
-        alias = 'Feature'
+        alias = 'Feature'  % nix-mx namespace to access Feature specific nix backend functions.
     end
 
     properties (Dependent)
@@ -39,15 +69,38 @@
         end
 
         function r = openData(obj)
+            % Returns the DataArray referenced by the invoking Feature.
+            %
+            % Returns:  (nix.DataArray) The unmodified DataArray entity
+            %                           referenced by the invoking Feature.
+            %
+            % Example: getDataArray = currFeature.openData();
+            %
+            % See also nix.DataArray.
+
             fname = strcat(obj.alias, '::openData');
             h = nix_mx(fname, obj.nixhandle);
             r = nix.Utils.createEntity(h, @nix.DataArray);
         end
 
-        function [] = setData(obj, data)
-            id = nix.Utils.parseEntityId(data, 'nix.DataArray');
+        function [] = setData(obj, idNameEntity)
+            % Sets the DataArray referenced by the invoking Feature.
+            %
+            % idNameEntity (char/nix.DataArray):  Name or id of the DataArray to be set 
+            %                                     or the DataArray itself. Sets the 
+            %                                     reference to the DataArray associated 
+            %                                     with the invoking Feature. Will replace
+            %                                     any previous set reference.
+            %
+            % Example:  currFeature.setData('some-data-array-id');
+            %           currFeature.setData('sessionData1');
+            %           currFeature.setData(dataArrayEntity);
+            %
+            % See also nix.DataArray.
+
+            parsed = nix.Utils.parseEntityId(idNameEntity, 'nix.DataArray');
             fname = strcat(obj.alias, '::setData');
-            nix_mx(fname, obj.nixhandle, id);
+            nix_mx(fname, obj.nixhandle, parsed);
         end
     end
 

+nix/LinkType.m

@@ -1,3 +1,8 @@
+% nix.LinkType class providing constant tyoes available for nix.Features
+%
+% See also nix.Feature.
+%
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,7 +12,6 @@
 % LICENSE file in the root of the Project.
 
 classdef LinkType
-    % LINKTYPE nix link types
 
     properties (Constant)
         Tagged = uint8(0);

tests/TestFeature.m

@@ -1,3 +1,5 @@
+% TestFeature provides tests for all supported nix.Feature methods.
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,15 +9,13 @@
 % LICENSE file in the root of the Project.
 
 function funcs = TestFeature
-% TESTFEATURE tests for Feature
-
     funcs = {};
     funcs{end+1} = @testOpenData;
     funcs{end+1} = @testHandleLinkType;
     funcs{end+1} = @testSetData;
 end
 
-%% Test: Open data from feature
+%% Test: Open data from Feature
 function [] = testOpenData ( varargin )
     f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
     b = f.createBlock('featureTest', 'nixBlock');
@@ -27,7 +27,7 @@
     assert(~isempty(feat.openData));
 end
 
-%% Test: Get and set nix.LinkType
+%% Test: Get and set LinkType
 function [] = testHandleLinkType ( varargin )
     fileName = 'testRW.h5';
     f = nix.File(fullfile(pwd, 'tests', fileName), nix.FileMode.Overwrite);
@@ -63,7 +63,7 @@
     assert(f.blocks{1}.tags{1}.features{1}.linkType == 2);
 end
 
-%% Test: Set data by entity, ID and name
+%% Test: Set data by entity, id and name
 function [] = testSetData ( varargin )
     fileName = 'testRW.h5';
     daName1 = 'featTestDA1';