@cntwg/xml-lib-js 0.0.30 → 0.0.32

package/doc/xmldoc-lib.md

@@ -1,11 +1,29 @@
->|***rev.*:**|0.1.30|
+>|***rev.*:**|0.1.37|
 >|:---|---:|
->|date:|2024-09-23|
+>|date:|2025-02-06|
 
 ## Introduction
 
 This paper describes a constants, functions and an object classes provided by `xmldoc-lib.js` module.
 
+### Base type definitions
+
+This section contains some definitions for a general types of the objects (e.g. options set) that frequently used in a function or a class method descriptions.
+
+<a name="typedef+fsoDescr"></a>
+#### `fsoDescr` - descriptor
+
+This descriptor is an `object` that describes a status for an operation with some FS-object (*e.g. object such as a file*).
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `isERR` | `boolean` | no | a flag which indicates whether an error was happen |
+| `errCode` | `number` | yes | an error code |
+| `errEvent` | `string` | no | an error event identifier |
+| `errMsg` | `string` | no | an error message |
+| `source` | `string` | no | path to a file |
+| `content` | `any` | no | content |
+
 ## Module constants
 
 ### **XML\_DEF\_PARSE_OPTIONS**
@@ -51,24 +69,39 @@ This constant defines a default value for naming the language attribute for XML-
 
 > Note: Purpose of those functions will be discussed and some may be deprecate and make obsolete or functionality may be altered. So use it with cautions in mind.
 
+<a name="readAsTagName"></a>
 #### **readAsTagName(value)** => `string`
 
-> since: `v0.0.28`
+> since: \[`v0.0.28`]
 
 This function tries to convert a given `value` to the value of type which is suitable for an XML-element's tag name. If failed an empty string is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | some value to read |
+
+<a name="readAsAttrName"></a>
 #### **readAsAttrName(value)** => `string`
 
-> since: `v0.0.28`
+> since: \[`v0.0.28`]
 
 This function tries to convert a given `value` to the value of type which is suitable for an XML-element's attribute name. If failed an empty string is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | some value to read |
+
+<a name="valueToElementID"></a>
 #### **valueToElementID(value)**
 
-> since: `v0.0.28`
+> since: \[`v0.0.28`]
 
 This function tries to convert a given `value` to the value of a valid identifier which is suitable for an XML-element's ID-attribute. If failed an empty string is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | some value to read |
+
 ## Module classes
 
 ### **TXmlContentParseOptions**
@@ -100,6 +133,7 @@ The table below describes a properties of a `TXmlContentParseOptions` class:
 
 This method transforms a given object to a set of accepted parser options.
 
+<a name="TXmlAttributesMapper"></a>
 ### **TXmlAttributesMapper**
 
 This class implements a proxy interface for handling attributes of an element.
@@ -112,18 +146,18 @@ The class constructor creates a new instance of the class.
 
 The class constructor receives an arguments listed below:
 
-|parameter name|value type|default value|description|
+| parameter name | value type | default value | description |
 |:---|---|---:|:---|
-|`object`|---|---|a host object that holds an attributes|
-|`options`|`object`|---|an options settings|
+| `object` | `object` | --- | a host object that holds an attributes |
+| `options` | `object` | --- | an options settings |
 
 ###### `options` parameter
 
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (*see description for `XML_DEF_PARSE_OPTIONS`*)|
+| `parseOptions` | `object` | `EMPTY_OBJECT` | contains a XML-parse options (*see description for `XML_DEF_PARSE_OPTIONS`*) |
 
 ##### exceptions
 
@@ -131,39 +165,71 @@ If `object` parameter is not a type of `object` or not given a `TypeError` throw
 
 #### class properties
 
-|property name|value type|read only|description|
-|:---|---|---|:---|
-|`entries`|`array`|yes|returns an array of entries for all existing attributes|
+<a name="TXmlAttributesMapper+entries"></a>
+##### **entries**
+
+| property type | read only | description |
+|---|---|:---|
+| `array` | yes | contains a list of entries for all existing attributes |
 
 
 #### class methods
 
+<a name="TXmlAttributesMapper+hasAttribute"></a>
 ##### **hasAttribute(name)** => `boolean`
 
 This method checks whether or not an attribute addressed by a `name` exists. If attribute exists, 'true' is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlAttributesMapper+getAttribute"></a>
 ##### **getAttribute(name)** => `string`
 
 This method returns an attribute value addressed by a `name`. If attribute is not exists the empty string is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlAttributesMapper+setAttribute"></a>
 ##### **setAttribute(name, value)** => `boolean`
 
 This method sets an attribute value addressed by a `name` and return `true` if succeed.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+| `value` | `any` | --- | some value |
+
+<a name="TXmlAttributesMapper+delAttribute"></a>
 ##### **delAttribute(name)** => `boolean`
 
 This method clears an attribute value addressed by a `name`.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlAttributesMapper+renameAttribute"></a>
 ##### **renameAttribute(name, value)** => `boolean`
 
-> since: `v0.0.30`
+> since: \[`v0.0.30`]
 
 This method renames an attribute addressed by a `name` to its new name given by a `value` parameter.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+| `value` | `string` | --- | new name of the attribute |
+
+<a name="TXmlAttributesMapper+clear"></a>
 ##### **clear()** => `void`
 
 This method clears all attributes.
 
+<a name="TXmlElementController"></a>
 ### **TXmlElementController**
 
 This class implements a proxy interface for an element.
@@ -176,19 +242,19 @@ The class constructor creates a new instance of the class.
 
 The class constructor receives an arguments listed below:
 
-|parameter name|value type|default value|description|
+| parameter name | value type | default value | description |
 |:---|---|---:|:---|
-|`object`|`object`|---|a host object|
-|`options`|`object`|---|an options settings|
+| `object` | `object` | --- | a host object |
+| `options` | `object` | --- | an options settings |
 
 ###### `options` parameter
 
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`proxyModeEnable`|`boolean`|`false`|<*reserved*>|
-|`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`)|
+| `proxyModeEnable` | `boolean` | `false` | <*reserved*> |
+| `parseOptions` | `object` | `EMPTY_OBJECT` | contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`) |
 
 ##### exceptions
 
@@ -196,40 +262,83 @@ If `object` parameter is not a type of `object` or not given a `TypeError` throw
 
 #### class properties
 
+<a name="TXmlElementController+attributes"></a>
+##### **attributes**
+
+| property type | read only | description |
+|---|---|:---|
+| `TXmlAttributesMapper` | yes | returns an attributes of the element |
+
+<a name="TXmlElementController+textValue"></a>
+##### **textValue**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | represents a value of the element |
+
+#### class properties (*others*)
+
 |property name|value type|read only|description|
 |:---|---|---|:---|
-|`attributes`|`TXmlAttributesMapper`|yes|returns an attributes of the element|
 |`name`||yes|\<*reserved*>|
-|`textValue`|`string`|no|represents a value of the element|
 
 #### class methods
 
+<a name="TXmlElementController+hasAttribute"></a>
 ##### **hasAttribute(name)** => `boolean`
 
 This method checks whether or not an attribute addressed by a `name` exists. If attribute exists, 'true' is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlElementController+getAttribute"></a>
 ##### **getAttribute(name)** => `string`
 
 This method returns an attribute value addressed by a `name`. If attribute is not exists the empty string is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlElementController+setAttribute"></a>
 ##### **setAttribute(name, value)** => `boolean`
 
 This method sets an attribute value addressed by a `name` and return `true` if succeed.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+| `value` | `any` | --- | some value |
+
+<a name="TXmlElementController+delAttribute"></a>
 ##### **delAttribute(name)** => `boolean`
 
 This method clears an attribute value addressed by a `name` parameter.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+
+<a name="TXmlElementController+renameAttribute"></a>
 ##### **renameAttribute(name, value)** => `boolean`
 
-> since: `v0.0.30`
+> since: \[`v0.0.30`]
 
 This method renames an attribute addressed by a `name` to its new name given by a `value` parameter.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some attribute name |
+| `value` | `string` | --- | new name of the attribute |
+
+<a name="TXmlElementController+getTextValue"></a>
 ##### **getTextValue()** => `array`
 
 This method returns an array witch contain a value of a `textValue` property and a value of a `lang` attribute in format: `[ <lang>, <textValue> ]`. If element has no `lang` attribute, it replaced by an empty string in the result.
 
+<a name="TXmlElementController+setTextValue"></a>
 ##### **setTextValue(value)** => `boolean`
 
 This method sets the value of a `textValue` property and its `lang` attribute and if succeed returns `true`.
@@ -240,24 +349,45 @@ The method received value that can be a string or an array. If value is an array
 or
 `[ <lang>, <textValue> ]`.
 
+<a name="TXmlElementController+hasChild"></a>
 ##### **hasChild(name)** => `boolean`
 
 This method checks whether or not a child element addressed by `name` is exists.
 
-##### **getChild(name)** => `?(TXmlElementController|TXmlElementsListController)`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some child element name |
+
+<a name="TXmlElementController+getChild"></a>
+##### **getChild(name)** => `null`\|`TXmlElementController`\|`TXmlElementsListController`
 
 This method returns a child element addressed by `name`. If failed `null` is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some child element name |
+
+<a name="TXmlElementController+addChild"></a>
 ##### **addChild(name)** => `?TXmlElementController`
 
 This method adds a new element as a child element addressed by a `name` parameter.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some child element name |
+
+<a name="TXmlElementController+delChild"></a>
 ##### **delChild(name)** => `boolean`
 
 This method deletes a child element addressed by a `name`.
 
 > Warning: A method not fully implemented yet. Not use it for list like elements. If list contains a more than one element, a method will fail.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `name` | `string` | --- | some child element name |
+
+<a name="TXmlElementController+clear"></a>
 ##### **clear()** => `void`
 
 This method clears an element content.
@@ -266,38 +396,68 @@ This method clears an element content.
 
 > Note: Purpose of those methods will be discussed and some may be deprecate and make obsolete or functionality may be altered. So use it with cautions in mind.
 
+<a name="TXmlElementController+loadFromXMLString"></a>
 ##### **loadFromXMLString(str)** => `boolean`
 
 This method loads an element content from a string given by a `str` parameter.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `str` | `string` | --- | some content |
+
 ###### *exceptions*
 
-This methods trows `Error` if something goes wrong through a parsing process of a string.
+This methods throws `Error` if something goes wrong through a parsing process of a string.
 
 #### class methods (*special*)
 
-##### **_getChildRaw(name)**
+##### **_getChildRaw(name)** => `?any`
 
-This method returns a child element addressed by `name` as object.
+> WARNING: **\[since `v0.0.31`]** this method deprecated (*use static `__getChildRaw` method of the class*).
 
-##### **_addChildRaw(name)**
+##### **_addChildRaw(name)** => `?object`
 
-This method adds an element as a child element addressed by `name`.
+> WARNING: **\[since `v0.0.31`]** this method deprecated (*use static `__addChildRaw` method of the class*).
 
-##### **_setChildRaw(name, obj)**
+##### **_setChildRaw(name, obj)** => `boolean`
 
-This method inserts a given object as a child element addressed by `name`.
+> WARNING: **\[since `v0.0.31`]** this method deprecated (*use static `__setChildRaw` method of the class*).
 
 #### class methods (*static*)
 
-##### **__unwrap(item)**
+##### **clear(item)** => `void`
+
+This method clears an `item` content.
+
+##### **create(obj, opt)** => `?(TXmlElementController|TXmlElementsListController)`
+
+> since: \[`v0.0.30`]
+
+This method creates an instance from a given object.
+
+#### class methods (*static, special*)
+
+##### **__unwrap(node)** => `?object`
 
 This method returns a host for an element as an object. If failed `null` is returned.
 
-##### **clear(item)** => `void`
+##### **__getChildRaw(node, name)** => `?any`
 
-This method clears an `item` content.
+> since: \[`v0.0.31`]
+
+This method returns a child element addressed by `name` as object. If failed `null` is returned.
+
+##### **__addChildRaw(node, name)** => `?object`
+
+> since: \[`v0.0.31`]
+
+This method adds an element addressed by `name` as a child element.
+
+##### **__setChildRaw(node, name, obj)** => `boolean`
+
+This method inserts a given object as a child element addressed by `name`.
 
+<a name="TXmlElementsListController"></a>
 ### **TXmlElementsListController**
 
 This class implements a proxy interface for a list of elements.
@@ -310,20 +470,20 @@ The class constructor creates a new instance of the class.
 
 The class constructor receives an arguments listed below:
 
-|parameter name|value type|default value|description|
+| parameter name | value type | default value | description |
 |:---|---|---:|:---|
-|`object`|`array`|---|a host object of an array type.|
-|`options`|`object`|---|an options settings.|
+| `object` | `object[]` | --- | a host object of an array type |
+| `options` | `object` | --- | an options settings |
 
 ###### `options` parameter
 
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`proxyModeEnable`|`boolean`|`false`|<*reserved*>|
-|`isNullItemsAllowed`|`boolean`|`false`|<*reserved*>|
-|`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`)|
+| `proxyModeEnable` | `boolean` | `false` | <*reserved*> |
+| `isNullItemsAllowed` | `boolean` | `false` | <*reserved*> |
+| `parseOptions` | `object` | `EMPTY_OBJECT` | contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`) |
 
 ##### exceptions
 
@@ -331,64 +491,131 @@ If `object` parameter is not a type of `array` or not given a `TypeError` may be
 
 #### class properties
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`count`|`number`|yes|returns a quantity of the elements|
-|`size`|`number`|yes|returns a quantity of the elements|
-|`maxIndex`|`index`|yes|returns a last possible index of the elements|
-|`isNullItemsAllowed`|`boolean`|yes|indicates whether a list may be filled  with the null-elements or not|
+<a name="TXmlElementsListController+count"></a>
+##### **count**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | returns a quantity of the elements |
+
+<a name="TXmlElementsListController+size"></a>
+##### **size**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | returns a quantity of the elements |
+
+<a name="TXmlElementsListController+maxIndex"></a>
+##### **maxIndex**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | returns a last possible index of the element |
+
+<a name="TXmlElementsListController+isNullItemsAllowed"></a>
+##### **isNullItemsAllowed**
+
+| property type | read only | description |
+|---|---|:---|
+| `boolean` | yes | indicates whether a list may be filled  with the `null`-elements or not |
 
 #### class methods
 
+<a name="TXmlElementsListController+clear"></a>
 ##### **clear()** => `void`
 
 This method clears a list.
 
+<a name="TXmlElementsListController+isEmpty"></a>
 ##### **isEmpty()** => `boolean`
 
 This method returns `true` if a list has no elements and `false` otherwise.
 
+<a name="TXmlElementsListController+isNotEmpty"></a>
 ##### **isNotEmpty()** => `boolean`
 
 This method returns `true` if a list contains at least one element and `false` otherwise.
 
-##### **chkIndex(index)** => `boolean`
+<a name="TXmlElementsListController+chkIndex"></a>
+##### **chkIndex(value)** => `boolean`
 
 This method checks if a given index fits a range of elements within the list. If so `true` is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string` | --- | some index value |
+
+<a name="TXmlElementsListController+isValidItem"></a>
 ##### **isValidItem(obj)** => `boolean`
 
 This method checks whether or not a given element is valid.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `any` | --- | some element to verify |
+
+<a name="TXmlElementsListController+getItem"></a>
 ##### **getItem(index)** => `?TXmlElementController`
 
 This method returns an element addressed by `index`. If failed `null` is returned.
 
-##### **addItem(obj)** => `index`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | element index |
+
+<a name="TXmlElementsListController+addItem"></a>
+##### **addItem(obj)** => `number`
 
 This method adds an element to a list members. If succeed an index of the element is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `any` | --- | some element |
+
+<a name="TXmlElementsListController+_setItemRaw"></a>
 ##### **setItem(index, obj)** => `boolean`
 
 This method replaces an element addressed by `index` with a new element. If succeed `true` is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | element index |
+| `obj` | `any` | --- | some element |
+
+<a name="TXmlElementsListController+insItem"></a>
 ##### **insItem(index, obj)** => `boolean`
 
 This method inserts an element in the position addressed by `index`. If succeed `true` is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | element index |
+| `obj` | `any` | --- | some element |
+
+<a name="TXmlElementsListController+delItem"></a>
 ##### **delItem(index)** => `boolean`
 
 This method deletes an element addressed by `index`. If succeed `true` is returned.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | element index |
+
+<a name="TXmlElementsListController+loadItems"></a>
 ##### **loadItems(items, options)** => `number`
 
 This method loaded a list of elements listed by `items` and returns a quantity of a successfully added elements.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `items` | `object`, `object[]` | --- | element or a list of an elements |
+| `options` | `object` | --- | options |
+
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`useClear`|`boolean`|`true`|if `true` the method deletes all the previous content before load the list|
+| `useClear` | `boolean` | `true` | if `true` the method deletes all the previous content before load the list |
 
 #### class methods (*special*)
 
@@ -408,6 +635,7 @@ This method replaces an element addressed by `index` with a new element which is
 
 This method inserts an element as a raw object in the position addressed by `index`. If succeed `true` is returned.
 
+<a name="TXmlContentDeclaration"></a>
 ### **TXmlContentDeclaration**
 
 This class implements a proxy interface for a document declaration element.
@@ -420,18 +648,18 @@ The class constructor creates a new instance of the class.
 
 The class constructor receives an arguments listed below:
 
-|parameter name|value type|default value|description|
+| parameter name | value type | default value | description |
 |:---|---|---:|:---|
-|`object`|`object`|---|a host object for the document content.|
-|`options`|`object`|---|an options settings.|
+| `object` | `object` | --- | a host object for the document content |
+| `options` | `object` | --- | an options settings |
 
 ###### `options` parameter
 
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`)|
+| `parseOptions` | `object` | `EMPTY_OBJECT` | contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`) |
 
 ##### exceptions
 
@@ -439,10 +667,19 @@ If `object` parameter is not a type of `object` or not given a `TypeError` throw
 
 #### class properties
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`version`|`string`|no|returns a version of a XML|
-|`encoding`|`string`|no|returns an encodings used by a document|
+<a name="TXmlContentDeclaration+version"></a>
+##### **version**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | returns a version of an XML |
+
+<a name="TXmlContentDeclaration+encoding"></a>
+##### **encoding**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | returns a name of the character set used by the document |
 
 #### class methods (*special*)
 
@@ -495,6 +732,7 @@ The `options` parameter, if given, change a behavior for the method. If set to '
 
 #### class methods (*special*)
 
+<a name="TXmlContentContainer"></a>
 ### **TXmlContentContainer**
 
 This class implements a proxy interface for manipulate a content of a document.
@@ -511,52 +749,82 @@ The class constructor receives an `options` parameter as its argument.
 
 The `options` structure is listed below:
 
-|option name|value type|default value|description|
+| option name | value type | default value | description |
 |:---|---|---:|:---|
-|`rootETagName`|`string`|`root`|contains a the name of a tag that represents a root element|
-|`autoBindRoot`|`boolean`|`true`|<*reserved*>|
-|`proxyModeEnable`|`boolean`|`false`|<*reserved*>|
-|`isNullItemsAllowed`|`boolean`|`false`|<*reserved*>|
-|`parseOptions`|`object`|`EMPTY_OBJECT`|contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`)|
+| `rootETagName` | `string` | `root` | contains a the name of a tag that represents a root element |
+| `autoBindRoot` | `boolean` | `true` | <*reserved*> |
+| `proxyModeEnable` | `boolean` | `false` | <*reserved*> |
+| `isNullItemsAllowed` | `boolean` | `false` | <*reserved*> |
+| `parseOptions` | `object` | `EMPTY_OBJECT` | contains a XML-parse options (see description for `XML_DEF_PARSE_OPTIONS`) |
 
 #### class properties
 
-|property name|value type|read only|description|
-|:---|---|---|:---|
-|rootElement||yes|returns a document root element|
+<a name="TXmlContentContainer+rootElement"></a>
+##### **rootElement**
+
+| property type | read only | description |
+|---|---|:---|
+| `TXmlContentRootElement` | yes | returns a document root element |
 
 #### class methods
 
+<a name="TXmlContentContainer+clear"></a>
 ##### **clear()** => `void`
 
 This method clears a document content.
 
+<a name="TXmlContentContainer+saveToXMLString"></a>
 ##### **saveToXMLString()** => `string`
 
 This method returns a document content as a string.
 
-##### **saveToFileSync(src)**
+<a name="TXmlContentContainer+saveToFileSync"></a>
+##### **saveToFileSync(src)** => `fsoDescr`
 
 This method saves a document content into a file addressed by `src`.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
+
+<a name="TXmlContentContainer+loadFromXMLString"></a>
 ##### **loadFromXMLString(str)** => `boolean`
 
 This method loads a document content from a string given by `str`.
 
-##### **loadFromFileSync(src)**
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `str` | `string` | --- | some content |
+
+<a name="TXmlContentContainer+loadFromFileSync"></a>
+##### **loadFromFileSync(src)** => `fsoDescr`
 
 This method loads a document content from a file addressed by `src`.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
+
 #### class methods (*async*)
 
-##### **saveToFile(src)**
+<a name="TXmlContentContainer+saveToFile"></a>
+##### **saveToFile(src)** => `Promise<fsoDescr, Error>`
 
 This method saves a document content into a file addressed by `src`.
 
-##### **loadFromFile(src)**
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
+
+<a name="TXmlContentContainer+loadFromFile"></a>
+##### **loadFromFile(src)** => `Promise<fsoDescr, Error>`
 
 This method loads a document content from a file addressed by `src`.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
+
 #### class methods (*special*)
 
 ##### **asJSON()**