Configuration-examples.md

matdoc.Configuration: Examples

The configuration of the UML export is generally controlled by the public properties.

The following properties can be set:

• HideEnumerationMember
• HideEvents
• HideInheritance
• HideMethods
• HideProperties
• IgnoreBuiltInClass
• IgnoreBuiltInInheritance
• IgnoreBuiltInMethodInheritance
• IgnoreBuiltInPropertyInheritance
• IgnoreTests
• InheritanceHint
• MethodInheritanceHint
• OnlyRelationship
• PropertyDescription
• PropertyInheritanceHint
• SafeUmlExport

Default Behaviour

The behavior of each setting, the class diagram of matdoc.meta.Class and matdoc.enums.AccessLevel is used. Below you'll the output with the default settings:

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    'matdoc.tests.testTools',...
    });
theDoc.UmlToFile('\doc\uml-examples\export-class.txt');

The UML output: export-class.txt

Properties

HideEnumerationMember

Flag: true or false Default: false If set the UML won't contain any information about enumeration members

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'HideEnumerationMember', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-HideEnumerationMember-true.txt');

The UML output: export-class-HideEnumerationMember-true.txt

HideEvents

Flag: true or false Default: false If set the UML won't contain any information about events

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'HideEvents', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-HideEvents-true.txt');

The UML output: export-class-HideEvents-true.txt

HideInheritance

Flag: true or false Default: false If set the UML won't contain any information about inheritances If you specify inheritances your self, they will still be displayed!

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'HideInheritance', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-HideInheritance-true.txt');

The UML output: export-class-HideInheritance-true.txt

HideMethods

Flag: true or false Default: false If set the UML won't contain any information about methods

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'HideMethods', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-HideMethods-true.txt');

The UML output: export-class-HideMethods-true.txt

HideProperties

Flag: true or false Default: false If set the UML won't contain any information about properties

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'HideProperties', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-HideProperties-true.txt');

The UML output: export-class-HideProperties-true.txt

IgnoreBuiltInClass

Flag: true or false Default: false If set the uml export will not contain refrences to built-in classes

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'IgnoreBuiltInClass', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-IgnoreBuiltInClass-true.txt');

The UML output: export-class-IgnoreBuiltInClass-true.txt

IgnoreBuiltInInheritance

IgnoreBuiltInMethodInheritance and IgnoreBuiltInPropertyInheritance combined.

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'IgnoreBuiltInInheritance', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-IgnoreBuiltInInheritance-false.txt');

The UML output: export-class-IgnoreBuiltInInheritance-false.txt

IgnoreBuiltInMethodInheritance

Flag: true or false Default: true If set the uml export will not contain methods inheritated from built-in classes

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'IgnoreBuiltInMethodInheritance', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-IgnoreBuiltInMethodInheritance-false.txt');

The UML output: export-class-IgnoreBuiltInMethodInheritance-false.txt

IgnoreBuiltInPropertyInheritance

Flag: true or false Default: true If set the uml export will not contain properties inheritated from built-in classes

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'IgnoreBuiltInPropertyInheritance', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-IgnoreBuiltInPropertyInheritance-false.txt');

The UML output: export-class-IgnoreBuiltInPropertyInheritance-false.txt

IgnoreTests

Flag: true or false Default: true If set the export will not contain any classes which are from the matlab unittesting framework or inheritated from the unit testing frame work

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'IgnoreTests', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-IgnoreTests-false.txt');

The UML output: export-class-IgnoreTests-false.txt

InheritanceHint

MethodInheritanceHint and PropertyInheritanceHint combined.

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'InheritanceHint', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-InheritanceHint-false.txt');

The UML output: export-class-InheritanceHint-false.txt

MethodInheritanceHint

Flag: true or false Default: true If set the UML will contain information about inhertitated methods at the end of the line

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'MethodInheritanceHint', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-MethodInheritanceHint-false.txt');

The UML output: export-class-MethodInheritanceHint-false.txt

OnlyRelationship

Hiddes all methods, properties, events and enumeration members to let the user focus on the relation between the classes. This can be helfull when the Diagram is very large or fairly complicated.

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'OnlyRelationship', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-OnlyRelationship-true.txt');

The UML output: export-class-OnlyRelationship-true.txt

PropertyDescription

Flag: true or false Default: false If set the description of each property will be added to the UML diagram

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'PropertyDescription', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-PropertyDescription-true.txt');

The UML output: export-class-PropertyDescription-true.txt

PropertyInheritanceHint

Flag: true or false Default: true If set the UML will contain information about inhertitated properties at the end of the line

Default: true

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'PropertyInheritanceHint', false...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-PropertyInheritanceHint-false.txt');

The UML output: export-class-PropertyInheritanceHint-false.txt

SafeUmlExport

Flag: true or fals Default: false If set the UML export will be done class wise instead of nesting classes into their packages. This can address issues when the classe diagram looks funky or classes are actually completly missing form diagram. This is mainly caused by naming conflicts when classes and packages have the same name.

Default: false

Example

theDoc = matdoc.Documentation({...
   'matdoc.meta.Class',...
   'matdoc.enums.AccessLevel'...
    },...
    'SafeUmlExport', true...
    );
theDoc.UmlToFile('doc\uml-examples\export-class-SafeUmlExport-true.txt');

The UML output: export-class-SafeUmlExport-true.txt