@fluid-experimental/property-changeset 1.2.7 → 2.0.0-dev.1.3.0.96595

package/dist/changeset.d.ts

@@ -104,12 +104,12 @@ export declare class ChangeSet {
     /**
      * Applies a changeset to a given property (recursively). The ChangeSet is assumed to be relative to the same
      * property root and it will be applied behind the base ChangeSet (assuming that the changes are relative to the
-     * state after the base ChangeSet has been applied. It will change the base ChangeSet.)
+     * state after the base ChangeSet has been applied. It will change the base ChangeSet).
      *
-     * @param io_basePropertyChanges    - The ChangeSet describing the initial state
-     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param io_basePropertyChanges - The ChangeSet describing the initial state.
+     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     private _performApplyAfterOnProperty;
     /**
@@ -125,14 +125,14 @@ export declare class ChangeSet {
     /**
      * Decides based on the given Typeid which applyAfter operation to perform.
      * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * since it needs to be able to overwrite this entry
      *
-     * @param in_changedKey             - The key of the entry in the object
-     * @param in_baseChanges            - The object containing the state before the applyAfter
-     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification
-     * @param in_typeid                 - The typeid of the property to modify
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param in_changedKey - The key of the entry in the object.
+     * @param in_baseChanges - The object containing the state before the applyAfter.
+     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification.
+     * @param in_typeid - The typeid of the property to modify.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     performApplyAfterOnPropertyWithTypeid(in_changedKey: string, in_baseChanges: SerializedChangeSet, in_appliedPropertyChanges: {
         [x: string]: any;
@@ -144,55 +144,49 @@ export declare class ChangeSet {
      * this class and transforms it in such a way that it can be applied after this ChangeSet. The function will modify
      * the supplied ChangeSet
      *
-     * @param io_changeSet   -
-     *     The ChangeSet that is rebased behind the state obtained by application of this ChangeSet
-     * @param out_conflicts A list of paths that resulted in conflicts together with the type of the conflict
-     * @param in_options - Optional additional parameters
+     * @param io_changeSet - The ChangeSet that is rebased behind the state obtained by application of this ChangeSet.
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
+     * @param in_options - Optional additional parameters.
      * @returns The rebased ChangeSet (the same object as io_changeSet, it will be
-     *     modified in place)
+     * modified in place).
      */
     _rebaseChangeSet(io_changeSet: SerializedChangeSet, out_conflicts: ConflictInfo[], in_options?: RebaseChangeSetOptions): SerializedChangeSet;
     /**
      * Internal helper function that performs a rebase on a single property
      *
-     * @param in_ownPropertyChangeSet -
-     *     The ChangeSet for the property stored in this class
-     * @param io_rebasePropertyChangeSet -
-     *     The ChangeSet for the property to be rebased
-     * @param in_basePath -
-     *     Base path to get to the property processed by this function
-     * @param out_conflicts -
-     *     A list of paths that resulted in conflicts together with the type of the conflict
+     * @param in_ownPropertyChangeSet - The ChangeSet for the property stored in this class
+     * @param io_rebasePropertyChangeSet - The ChangeSet for the property to be rebased
+     * @param in_basePath - Base path to get to the property processed by this function
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict
      * @param in_options - Optional additional parameters
      * @returns The rebased ChangeSet for this property
      */
     private _rebaseChangeSetForProperty;
     /**
-     * Decides based on the given Typeid which rebase operation to perform
-     * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * Decides based on the given Typeid which rebase operation to perform.
+     *
+     * @remarks Note: This function is not directly called on the ChangeSet but on the object containing it together
+     * with a key since it needs to be able to overwrite this entry
      *
-     * @param in_key                          - The key of the entry in the object
-     * @param in_ownPropertyChangeSet         - The object containing the ChangeSet for the property
-     *                                                   stored in this class
-     * @param io_rebasePropertyChangeSet      - The object containing the ChangeSet for the property to
-     *                                                   be rebased
-     * @param in_typeid                       - The typeid of the property to rebase
-     * @param in_basePath                     - Base path to get to the property processed by this function
-     * @param in_removeEmpty                 - Should empty ChangeSets be removed?
-     * @param out_conflicts - A list of paths that resulted in
-     *                                                   conflicts together with the type of the conflict
+     * @param in_key - The key of the entry in the object
+     * @param in_ownPropertyChangeSet - The object containing the ChangeSet for the property stored in this class.
+     * @param io_rebasePropertyChangeSet - The object containing the ChangeSet for the property to be rebased.
+     * @param in_typeid - The typeid of the property to rebase.
+     * @param in_basePath - Base path to get to the property processed by this function.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
      *
      * @returns Has there been a simple set collision? Those have to be handled separately
-     *                   TODO: We should unify the handling of set collisions
+     *
+     * @privateRemarks TODO: We should unify the handling of set collisions
      * @private
      */
     private rebaseChangeSetForPropertyEntryWithTypeid;
     /**
-     * recursive helper function for ChangeSet.prototype._toReversibleChangeSet
+     * Recursive helper function for ChangeSet.prototype._toReversibleChangeSet
      * which converts a irreversible changeset to a reversible changeset
      * or updates the former state of a reversible changeset
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     private _recursivelyBuildReversibleChangeSet;
     /**
@@ -201,7 +195,7 @@ export declare class ChangeSet {
      * WARNING: This function is still experimental and needs more testing
      * and it's set to private for now. It will be converted to a public API function
      * in a later release.
-     * @param in_oldSerializedState the old state
+     * @param in_oldSerializedState - The old state.
      */
     _toReversibleChangeSet(in_oldSerializedState: SerializedChangeSet): void;
     /**
@@ -214,15 +208,15 @@ export declare class ChangeSet {
     _stripReversibleChangeSet(in_withoutRoot: boolean): void;
     /**
      * Helper function to extract the first level paths from a given change set
-     * @param in_changeSet The ChangeSet to extract paths from
-     * @param isPrimitiveCollection Is this a primitive type collection?
+     * @param in_changeSet - The ChangeSet to extract paths from.
+     * @param isPrimitiveCollection - Is this a primitive type collection?
      *
      * @returns List of paths found at the first level of the change set
      */
     private _extractFirstLevelPaths;
     /**
      * recursive helper function for ChangeSet.prototype._toInverseChangeSet
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     private _recursivelyInvertReversibleChangeset;
     /**

package/dist/changeset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"changeset.d.ts","sourceRoot":"","sources":["../src/changeset.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH;;GAEG;AAaH,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EAAE,YAAY,EAAE,MAAM,+CAA+C,CAAC;AAE7E,OAAO,EAAE,mCAAmC,EAAE,MAAM,0CAA0C,CAAC;AAW/F,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,yBAAyB,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACjE,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,GAAG,CAAC;AACtC,oBAAY,aAAa,GAAG,GAAG,CAAC;AAChC,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;CAC3C;AAED;;;;GAIG;AACH,qBAAa,SAAS;IAClB,MAAM,CAAC,YAAY,sBAAgB;IACnC,MAAM,CAAC,gBAAgB,iCAAoB;IAC3C,MAAM,CAAC,iBAAiB,8BAAqB;IAE9B,gCAAgC,EAAE,OAAO,mCAAmC,CAAC,gCAAgC,CAAC;IAC9G,iCAAiC,EAAE,OAAO,uBAAuB,CAAC,iCAAiC,CAAC;IACpG,gCAAgC,EAAE,OAAO,uBAAuB,CAAC,gCAAgC,CAAC;IAClG,yBAAyB,EAAE,OAAO,uBAAuB,CAAC,yBAAyB,CAAC;IACpF,6CAA6C,EAAE,OAAO,mCAAmC,CAAC,6CAA6C,CAAC;IACxI,4CAA4C,EAAE,OAAO,mCAAmC,CAAC,4CAA4C,CAAC;IAErJ,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;gBACS,UAAU,CAAC,EAAE,aAAa;IAetC;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,sBAAsB,IAAI,mBAAmB;IAI7C;;;;;OAKG;IACH,eAAe,CAAC,eAAe,EAAE,OAAO;IAIxC;;;;;OAKG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;OAIG;IACH,KAAK,IAAI,SAAS;IAIlB;;;;;;;;OAQG;IACH,cAAc,CAAC,YAAY,EAAE,mBAAmB,EAAE,UAAU,CAAC,EAAE,qBAAqB;IAcpF;;;;;;;;;OASG;IACH,OAAO,CAAC,4BAA4B;IA+CpC;;;;;;;;OAQG;IACH,OAAO,CAAC,WAAW;IAkBnB;;;;;;;;;;;OAWG;IACI,qCAAqC,CACxC,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,mBAAmB,EACnC,yBAAyB,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EAChD,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,CAAC,EAAE,qBAAqB;IAqHtC;;;;;;;;;;;;;OAaG;IACI,gBAAgB,CAAC,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,YAAY,EAAE,EACpF,UAAU,CAAC,EAAE,sBAAsB,GAAG,mBAAmB;IAK7D;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,2BAA2B;IAuKnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,yCAAyC;IAwEjD;;;;;OAKG;IACH,OAAO,CAAC,oCAAoC;IAkM5C;;;;;;;OAOG;IACI,sBAAsB,CAAC,qBAAqB,EAAE,mBAAmB;IAuBxE;;;;;;OAMG;IACI,yBAAyB,CAAC,cAAc,EAAE,OAAO;IAmHxD;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,qCAAqC;IAoI7C;;;;;OAKG;IACI,kBAAkB;CAY5B"}
+{"version":3,"file":"changeset.d.ts","sourceRoot":"","sources":["../src/changeset.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH;;GAEG;AAaH,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,OAAO,EAAE,YAAY,EAAE,MAAM,+CAA+C,CAAC;AAE7E,OAAO,EAAE,mCAAmC,EAAE,MAAM,0CAA0C,CAAC;AAW/F,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,yBAAyB,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE1C;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACjE,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,GAAG,CAAC;AACtC,oBAAY,aAAa,GAAG,GAAG,CAAC;AAChC,MAAM,WAAW,YAAY;IACzB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;CAC3C;AAED;;;;GAIG;AACH,qBAAa,SAAS;IAClB,MAAM,CAAC,YAAY,sBAAgB;IACnC,MAAM,CAAC,gBAAgB,iCAAoB;IAC3C,MAAM,CAAC,iBAAiB,8BAAqB;IAE9B,gCAAgC,EAAE,OAAO,mCAAmC,CAAC,gCAAgC,CAAC;IAC9G,iCAAiC,EAAE,OAAO,uBAAuB,CAAC,iCAAiC,CAAC;IACpG,gCAAgC,EAAE,OAAO,uBAAuB,CAAC,gCAAgC,CAAC;IAClG,yBAAyB,EAAE,OAAO,uBAAuB,CAAC,yBAAyB,CAAC;IACpF,6CAA6C,EAAE,OAAO,mCAAmC,CAAC,6CAA6C,CAAC;IACxI,4CAA4C,EAAE,OAAO,mCAAmC,CAAC,4CAA4C,CAAC;IAErJ,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;gBACS,UAAU,CAAC,EAAE,aAAa;IAetC;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAIlB;;;;OAIG;IACH,sBAAsB,IAAI,mBAAmB;IAI7C;;;;;OAKG;IACH,eAAe,CAAC,eAAe,EAAE,OAAO;IAIxC;;;;;OAKG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;OAIG;IACH,KAAK,IAAI,SAAS;IAIlB;;;;;;;;OAQG;IACH,cAAc,CAAC,YAAY,EAAE,mBAAmB,EAAE,UAAU,CAAC,EAAE,qBAAqB;IAcpF;;;;;;;;;OASG;IACH,OAAO,CAAC,4BAA4B;IA+CpC;;;;;;;;OAQG;IACH,OAAO,CAAC,WAAW;IAkBnB;;;;;;;;;;;OAWG;IACI,qCAAqC,CACxC,aAAa,EAAE,MAAM,EACrB,cAAc,EAAE,mBAAmB,EACnC,yBAAyB,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,EAChD,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,CAAC,EAAE,qBAAqB;IAmHtC;;;;;;;;;;;;OAYG;IACI,gBAAgB,CAAC,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,YAAY,EAAE,EACpF,UAAU,CAAC,EAAE,sBAAsB,GAAG,mBAAmB;IAK7D;;;;;;;;;OASG;IACH,OAAO,CAAC,2BAA2B;IAuKnC;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,yCAAyC;IAwEjD;;;;;OAKG;IACH,OAAO,CAAC,oCAAoC;IAkM5C;;;;;;;OAOG;IACI,sBAAsB,CAAC,qBAAqB,EAAE,mBAAmB;IAuBxE;;;;;;OAMG;IACI,yBAAyB,CAAC,cAAc,EAAE,OAAO;IAmHxD;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAgB/B;;;OAGG;IACH,OAAO,CAAC,qCAAqC;IAoI7C;;;;;OAKG;IACI,kBAAkB;CAY5B"}

package/dist/changeset.js

@@ -124,12 +124,12 @@ class ChangeSet {
     /**
      * Applies a changeset to a given property (recursively). The ChangeSet is assumed to be relative to the same
      * property root and it will be applied behind the base ChangeSet (assuming that the changes are relative to the
-     * state after the base ChangeSet has been applied. It will change the base ChangeSet.)
+     * state after the base ChangeSet has been applied. It will change the base ChangeSet).
      *
-     * @param io_basePropertyChanges    - The ChangeSet describing the initial state
-     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param io_basePropertyChanges - The ChangeSet describing the initial state.
+     * @param in_appliedPropertyChanges - The ChangeSet to apply to this state.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     _performApplyAfterOnProperty(io_basePropertyChanges, in_appliedPropertyChanges, in_removeEmpty, in_options) {
         // Apply dynamic property operations
@@ -193,14 +193,14 @@ class ChangeSet {
     /**
      * Decides based on the given Typeid which applyAfter operation to perform.
      * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * since it needs to be able to overwrite this entry
      *
-     * @param in_changedKey             - The key of the entry in the object
-     * @param in_baseChanges            - The object containing the state before the applyAfter
-     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification
-     * @param in_typeid                 - The typeid of the property to modify
-     * @param in_removeEmpty            - Should empty ChangeSets be removed?
-     * @param in_options - Optional additional parameters
+     * @param in_changedKey - The key of the entry in the object.
+     * @param in_baseChanges - The object containing the state before the applyAfter.
+     * @param in_appliedPropertyChanges - The object containing the ChangeSet with the modification.
+     * @param in_typeid - The typeid of the property to modify.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param in_options - Optional additional parameters.
      */
     performApplyAfterOnPropertyWithTypeid(in_changedKey, in_baseChanges, in_appliedPropertyChanges, in_typeid, in_removeEmpty, in_options) {
         const splitTypeid = extractContext(in_typeid);
@@ -261,12 +261,9 @@ class ChangeSet {
                 if (baseIsSetChange) {
                     // we have to convert back to a string, if it had been converted before
                     let newValue;
-                    if ((0, isEmpty_1.default)(in_baseChanges[in_changedKey])) {
-                        newValue = "";
-                    }
-                    else {
-                        newValue = in_baseChanges[in_changedKey].insert[0][1];
-                    }
+                    newValue = (0, isEmpty_1.default)(in_baseChanges[in_changedKey])
+                        ? ""
+                        : in_baseChanges[in_changedKey].insert[0][1];
                     if (oldValue !== undefined) {
                         in_baseChanges[in_changedKey] = {
                             value: newValue,
@@ -324,12 +321,11 @@ class ChangeSet {
      * this class and transforms it in such a way that it can be applied after this ChangeSet. The function will modify
      * the supplied ChangeSet
      *
-     * @param io_changeSet   -
-     *     The ChangeSet that is rebased behind the state obtained by application of this ChangeSet
-     * @param out_conflicts A list of paths that resulted in conflicts together with the type of the conflict
-     * @param in_options - Optional additional parameters
+     * @param io_changeSet - The ChangeSet that is rebased behind the state obtained by application of this ChangeSet.
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
+     * @param in_options - Optional additional parameters.
      * @returns The rebased ChangeSet (the same object as io_changeSet, it will be
-     *     modified in place)
+     * modified in place).
      */
     _rebaseChangeSet(io_changeSet, out_conflicts, in_options) {
         // We actually only pass this request to the recursive internal function
@@ -338,14 +334,10 @@ class ChangeSet {
     /**
      * Internal helper function that performs a rebase on a single property
      *
-     * @param in_ownPropertyChangeSet -
-     *     The ChangeSet for the property stored in this class
-     * @param io_rebasePropertyChangeSet -
-     *     The ChangeSet for the property to be rebased
-     * @param in_basePath -
-     *     Base path to get to the property processed by this function
-     * @param out_conflicts -
-     *     A list of paths that resulted in conflicts together with the type of the conflict
+     * @param in_ownPropertyChangeSet - The ChangeSet for the property stored in this class
+     * @param io_rebasePropertyChangeSet - The ChangeSet for the property to be rebased
+     * @param in_basePath - Base path to get to the property processed by this function
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict
      * @param in_options - Optional additional parameters
      * @returns The rebased ChangeSet for this property
      */
@@ -477,23 +469,22 @@ class ChangeSet {
         return io_rebasePropertyChangeSet;
     }
     /**
-     * Decides based on the given Typeid which rebase operation to perform
-     * Note: This function is not directly called on the ChangeSet but on the object containing it together with a key
-     *       since it needs to be able to overwrite this entry
+     * Decides based on the given Typeid which rebase operation to perform.
      *
-     * @param in_key                          - The key of the entry in the object
-     * @param in_ownPropertyChangeSet         - The object containing the ChangeSet for the property
-     *                                                   stored in this class
-     * @param io_rebasePropertyChangeSet      - The object containing the ChangeSet for the property to
-     *                                                   be rebased
-     * @param in_typeid                       - The typeid of the property to rebase
-     * @param in_basePath                     - Base path to get to the property processed by this function
-     * @param in_removeEmpty                 - Should empty ChangeSets be removed?
-     * @param out_conflicts - A list of paths that resulted in
-     *                                                   conflicts together with the type of the conflict
+     * @remarks Note: This function is not directly called on the ChangeSet but on the object containing it together
+     * with a key since it needs to be able to overwrite this entry
+     *
+     * @param in_key - The key of the entry in the object
+     * @param in_ownPropertyChangeSet - The object containing the ChangeSet for the property stored in this class.
+     * @param io_rebasePropertyChangeSet - The object containing the ChangeSet for the property to be rebased.
+     * @param in_typeid - The typeid of the property to rebase.
+     * @param in_basePath - Base path to get to the property processed by this function.
+     * @param in_removeEmpty - Should empty ChangeSets be removed?
+     * @param out_conflicts - A list of paths that resulted in conflicts together with the type of the conflict.
      *
      * @returns Has there been a simple set collision? Those have to be handled separately
-     *                   TODO: We should unify the handling of set collisions
+     *
+     * @privateRemarks TODO: We should unify the handling of set collisions
      * @private
      */
     rebaseChangeSetForPropertyEntryWithTypeid(in_key, in_ownPropertyChangeSet, io_rebasePropertyChangeSet, in_typeid, in_basePath, in_removeEmpty, out_conflicts, in_options) {
@@ -542,10 +533,10 @@ class ChangeSet {
         return false;
     }
     /**
-     * recursive helper function for ChangeSet.prototype._toReversibleChangeSet
+     * Recursive helper function for ChangeSet.prototype._toReversibleChangeSet
      * which converts a irreversible changeset to a reversible changeset
      * or updates the former state of a reversible changeset
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     _recursivelyBuildReversibleChangeSet(in_context) {
         const opType = in_context.getOperationType();
@@ -744,7 +735,7 @@ class ChangeSet {
      * WARNING: This function is still experimental and needs more testing
      * and it's set to private for now. It will be converted to a public API function
      * in a later release.
-     * @param in_oldSerializedState the old state
+     * @param in_oldSerializedState - The old state.
      */
     _toReversibleChangeSet(in_oldSerializedState) {
         property_common_1.ConsoleUtils.assert(in_oldSerializedState !== undefined, `${MSG.ASSERTION_FAILED}Missing function parameter "in_oldSerializedState" of "_toReversibleChangeSet".`);
@@ -890,8 +881,8 @@ class ChangeSet {
     }
     /**
      * Helper function to extract the first level paths from a given change set
-     * @param in_changeSet The ChangeSet to extract paths from
-     * @param isPrimitiveCollection Is this a primitive type collection?
+     * @param in_changeSet - The ChangeSet to extract paths from.
+     * @param isPrimitiveCollection - Is this a primitive type collection?
      *
      * @returns List of paths found at the first level of the change set
      */
@@ -912,7 +903,7 @@ class ChangeSet {
     }
     /**
      * recursive helper function for ChangeSet.prototype._toInverseChangeSet
-     * @param in_context the traversal context
+     * @param in_context - The traversal context.
      */
     _recursivelyInvertReversibleChangeset(in_context) {
         in_context.setUserData(in_context.getUserData() || {});