Class DocumentationTemplate

Namespace

C4.Net.Documentation

Assembly

C4.Net.Core.dll

The superclass for all documentation templates.

public abstract class DocumentationTemplate

Inheritance

object

DocumentationTemplate

Derived

Arc42DocumentationTemplate

StructurizrDocumentationTemplate

ViewpointsAndPerspectivesDocumentation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DocumentationTemplate(Workspace)

Creates a new documentation template for the given workspace.

public DocumentationTemplate(Workspace workspace)

Parameters

workspace Workspace

the Workspace instance to create documentation for

Methods

AddImage(FileInfo)

Adds an image from the given file to the workspace.

public Image AddImage(FileInfo file)

Parameters

file FileInfo

a FileInfo representing the image file on disk

Returns

Image

an Image object representing the image added

AddImages(DirectoryInfo)

Adds png/jpg/jpeg/gif images in the given directory to the workspace.

public IEnumerable<Image> AddImages(DirectoryInfo directory)

Parameters

directory DirectoryInfo

a DirectoryInfo representing the directory containing image files

Returns

IEnumerable<Image>

The images that were added to the workspace.

AddSection(Component, string, Format, string)

Adds a custom section relating to a Component.

public Section AddSection(Component component, string name, Format format, string content)

Parameters

component Component

the Component the documentation content relates to

name string

the name of the section

format Format

the format of the documentation content

content string

a string containing the documentation content

Returns

Section

a documentation Section

AddSection(Component, string, params FileSystemInfo[])

Adds a custom section relating to a Component from one or more files.

public Section AddSection(Component component, string name, params FileSystemInfo[] files)

Parameters

component Component

the Component the documentation content relates to

name string

the name of the section

files FileSystemInfo[]

one or more FileInfo objects that point to the documentation content

Returns

Section

a documentation Section

AddSection(Container, string, Format, string)

Adds a custom section relating to a Container.

public Section AddSection(Container container, string name, Format format, string content)

Parameters

container Container

the Container the documentation content relates to

name string

the name of the section

format Format

the format of the documentation content

content string

a string containing the documentation content

Returns

Section

a documentation Section

AddSection(Container, string, params FileSystemInfo[])

Adds a custom section relating to a Container from one or more files.

public Section AddSection(Container container, string name, params FileSystemInfo[] files)

Parameters

container Container

the Container the documentation content relates to

name string

the name of the section

files FileSystemInfo[]

one or more FileInfo objects that point to the documentation content

Returns

Section

a documentation Section

AddSection(SoftwareSystem, string, Format, string)

Adds a custom section relating to a SoftwareSystem.

public Section AddSection(SoftwareSystem softwareSystem, string name, Format format, string content)

Parameters

softwareSystem SoftwareSystem

the SoftwareSystem the documentation content relates to

name string

the name of the section

format Format

the format of the documentation content

content string

a string containing the documentation content

Returns

Section

a documentation Section

AddSection(SoftwareSystem, string, params FileSystemInfo[])

Adds a custom section relating to a SoftwareSystem from one or more files.

public Section AddSection(SoftwareSystem softwareSystem, string name, params FileSystemInfo[] files)

Parameters

softwareSystem SoftwareSystem

the SoftwareSystem the documentation content relates to

name string

the name of the section

files FileSystemInfo[]

one or more FileInfo objects that point to the documentation content

Returns

Section

a documentation Section

AddSection(string, Format, string)

Adds a custom section, that isn't related to any element in the model.

public Section AddSection(string name, Format format, string content)

Parameters

name string

the name of the section

format Format

the format of the documentation content

content string

a string containing the documentation content

Returns

Section

a documentation section

AddSection(string, params FileInfo[])

Adds a custom section from a file, that isn't related to any element in the model.

public Section AddSection(string name, params FileInfo[] files)

Parameters

name string

the name of the section

files FileInfo[]

one or more FileInfo objects that point to the documentation content

Returns

Section

a documentation Section