[Matlab] Add basic nix.Property documentation

Author: mpsonntag

+nix/Property.m

@@ -1,3 +1,41 @@
+% nix.Property class contains the concrete values associated with metadata.
+%
+% nix.Property dynamic properties:
+%   id (char):          read-only, automatically created id of the entity.
+%   name (char):        read-only, name of the entity.      
+%   definition (char):  read-write, additional description of the entity.
+%   unit (char):        read-write, unit of the values associated with a Property.
+%                       The provided unit has to be an SI unit.
+%   datatype (char):    read-only, provides the datatype of the values associated 
+%                       with a Property. Attribute is set when the Property is created.
+%
+% nix.Property dynamic child entity properties:
+%   values     access to all value child entities.
+%
+% Property values can be set via the dynamic child entity property. When 
+% values are set, they replace any previously stored values. The new values
+% always have to be of a datatype supported by the Property.
+%
+% Example:  currProperty.values = {'last name', 'first name'};
+%
+% The values themselves have two properties: value and uncertainty which
+% can be accessed and updated individually.
+%
+% Individual values can be accessed and set by their value property. A set
+% value has to match the datatype of the Property.
+%
+% Example:  currProperty.values{1}.value                 %-- get first value of Property.
+%           currProperty.values{2}.value = 'some value'  %-- set second value of Property.
+%
+% Each value comes with its own uncertainty property which can be accessed
+% and set. NOTE: this will probably change in the near future, moving the
+% uncertainty from the individual value to the level of the Property.
+%
+% Example:  %-- get uncertainty of first property value.
+%           currProperty.values{1}.uncertainty
+%           %-- set uncertainty of second property value.
+%           currProperty.values{1}.uncertainty = 0.1
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,12 +45,9 @@
 % LICENSE file in the root of the Project.
 
 classdef Property < nix.NamedEntity
-    % PROPERTY Metadata Property class
-    %   NIX metadata property
 
     properties (Hidden)
-        % namespace reference for nix-mx functions
-        alias = 'Property'
+        alias = 'Property'  % nix-mx namespace to access Property specific nix backend functions.
     end
 
     properties (Dependent)
@@ -58,10 +93,20 @@
         end
 
         function r = valueCount(obj)
+            % Get the number of the child values of the invoking Property.
+            %
+            % Returns:  (uint) The number of child values.
+            %
+            % Example:  vc = currProperty.valueCount();
+
             r = nix.Utils.fetchEntityCount(obj, 'valueCount');
         end
 
         function [] = deleteValues(obj)
+            % Deletes all values from the invoking Property.
+            %
+            % Example:  check = currProperty.deleteValues();
+
             fname = strcat(obj.alias, '::deleteValues');
             nix_mx(fname, obj.nixhandle);
         end

tests/TestProperty.m

@@ -1,3 +1,5 @@
+% TestProperty provides tests for all supported nix.Property methods.
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,8 +9,6 @@
 % LICENSE file in the root of the Project.
 
 function funcs = TestProperty
-% TESTPROPERTY % Tests for the nix.Property object
-
     funcs = {};
     funcs{end+1} = @testAttributes;
     funcs{end+1} = @testUpdateValues;
@@ -140,7 +140,7 @@
     assert(isempty(f.sections{1}.properties{1}.values));
 end
 
-%% Test: Compare properties
+%% Test: Compare Properties
 function [] = testCompare( varargin )
     testFile = fullfile(pwd, 'tests', 'testRW.h5');
     f = nix.File(testFile, nix.FileMode.Overwrite);