[Matlab] Basic documentation for utility classes

Author: mpsonntag

+nix/DataType.m

@@ -1,3 +1,5 @@
+% nix.DataTypes provides access to the DataTypes supported by NIX.
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,7 +9,6 @@
 % LICENSE file in the root of the Project.
 
 classdef DataType
-    % DataTypes supported by nix.
 
     enumeration
         Bool;

+nix/Dynamic.m

@@ -1,3 +1,8 @@
+% Dynamic class implements methods to dynamically assign properties.
+%
+% Utility class, do not use out of context.
+%
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,8 +12,6 @@
 % LICENSE file in the root of the Project.
 
 classdef Dynamic
-    % Dynamic class (with static methods hehe)
-    % implements methods to dynamically assigns properties 
 
     methods (Static)
         function addProperty(obj, prop, mode)

+nix/Entity.m

@@ -1,3 +1,11 @@
+% Entity base class for nix entities.
+%
+% Class provides access to the info property and handles the lifetime
+% of a nix entitiy.
+%
+% Utility class, do not use out of context.
+%
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,8 +15,6 @@
 % LICENSE file in the root of the Project.
 
 classdef Entity < dynamicprops
-    % Entity base class for nix entities
-    %   handles object lifetime
 
     properties (Hidden)
         nixhandle
@@ -32,6 +38,8 @@
         end
 
         function r = updatedAt(obj)
+            % Provides the time the entity was last updated.
+
             r = nix_mx('Entity::updatedAt', obj.nixhandle);
         end
 

+nix/FileMode.m

@@ -1,3 +1,5 @@
+% nix.FileMode provides access to the Modes a NIX file can be opened.
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -7,7 +9,6 @@
 % LICENSE file in the root of the Project.
 
 classdef FileMode
-    % FILEMODE nix file open modes
 
     properties (Constant)
         ReadOnly = uint8(0);

+nix/Filter.m

@@ -1,5 +1,29 @@
+% nix.Filter provides access to all filters supported by nix filter functions.
+%
+% 'acceptall'  returns an unfiltered result; requires an empty value.
+% 'id'         returns all entities matching the provided id string.
+% 'ids'        returns all entities matching the provided ids. id strings
+%                have to be provided as a cell array.
+% 'type'       returns all entities where their type matches the provided string.
+% 'name'       returns all entities where their name matches the provided string.
+% 'metadata'   returns all entities which link to a Section with the
+%                provided id string.
+% 'source'     returns all entities which link to a Source with the
+%                provided id or name string.
+%
+% Please note, that not all filter functions support every filter listed
+% here. Consult the documentation for every filter function for details.
+%
+%
+% Copyright (c) 2017, German Neuroinformatics Node (G-Node)
+%
+% All rights reserved.
+%
+% Redistribution and use in source and binary forms, with or without
+% modification, are permitted under the terms of the BSD License. See
+% LICENSE file in the root of the Project.
+
 classdef Filter < uint8
-    % FILTER available nix custom filters
 
     enumeration
         acceptall (0); % requires an empty value

+nix/MetadataMixIn.m

@@ -7,7 +7,7 @@
 % to one nix.Section entity and therefore makes it possible to annotate the entities 
 % with additional metadata.
 %
-% Depends on nix.Entity.
+% Depends on nix.Entity; Utility class, do not use out of context.
 %
 % See also nix.Section, nix.Block, nix.Group, nix.DataArray, nix.Tag, nix.MultiTag, nix.Source, nix.Entity.
 %

+nix/Utils.m

@@ -1,3 +1,8 @@
+% nix.Utils provides utility functions accessing the nix backend.
+%
+% Utility functions, do not use out of context!
+%
+%
 % Copyright (c) 2016, German Neuroinformatics Node (G-Node)
 %
 % All rights reserved.
@@ -52,12 +57,13 @@
             r = nix.Utils.createEntityArray(list, objConstructor);
         end
 
-        % This method calls the nix-mx function specified by 'nixMxFunc', handing 
-        % over 'handle' as the main nix entity handle and 'relatedHandle' as a 
-        % second nix entity handle related to the first one.
-        % 'objConstructor' requires the Matlab entity constructor of the expected 
-        % returned nix Entities.
         function r = fetchObjListByEntity(obj, mxMethodName, relatedHandle, objConstructor)
+            % This method calls the nix-mx function specified by 'nixMxFunc', handing 
+            % over 'handle' as the main nix entity handle and 'relatedHandle' as a 
+            % second nix entity handle related to the first one.
+            % 'objConstructor' requires the Matlab entity constructor of the expected 
+            % returned nix Entities.
+
             mxMethod = strcat(obj.alias, '::', mxMethodName);
             list = nix_mx(mxMethod, obj.nixhandle, relatedHandle);
             r = nix.Utils.createEntityArray(list, objConstructor);
@@ -96,10 +102,11 @@
             nix_mx(mxMethod, obj.nixhandle, handleArray);
         end
 
-        % Function can be used for both nix delete and remove methods.
-        % The first actually removes the entity, the latter
-        % removes only the reference to the entity.
         function r = deleteEntity(obj, mxMethodName, idNameEntity, nixEntity)
+            % Function can be used for both nix delete and remove methods.
+            % The first actually removes the entity, the latter
+            % removes only the reference to the entity.
+
             mxMethod = strcat(obj.alias, '::', mxMethodName);
             id = nix.Utils.parseEntityId(idNameEntity, nixEntity);
             r = nix_mx(mxMethod, obj.nixhandle, id);
@@ -165,15 +172,17 @@
         % -----------------------------------------------------------
 
         function r = transposeArray(data)
-        % Data must agree with file & dimensions; see mkarray.cc(42)
+            % Data must agree with file & dimensions; see mkarray.cc(42)
+
             r = permute(data, length(size(data)):-1:1);
         end
 
         function r = handleIndex(idx)
-        % Matlab uses 1-based indexing opposed to 0 based indexing in C++.
-        % handleIndex transforms a Matlab style index to a C++ style
-        % index and raises the appropriate Matlab error in case of an
-        % invalid subscript.
+            % Matlab uses 1-based indexing opposed to 0 based indexing in C++.
+            % handleIndex transforms a Matlab style index to a C++ style
+            % index and raises the appropriate Matlab error in case of an
+            % invalid subscript.
+
             if (idx < 1)
                 err.identifier = 'MATLAB:badsubscript';
                 err.message = 'Subscript indices must either be real positive integers or logicals.';