Merge pull request #107 from lipkau/enhance/DocsForClasses

Add documentation of ConfluencePS classes

docs/classes/ConfluencePS.ContentLabelSet.md

@@ -0,0 +1,51 @@
+---
+layout: documentation
+permalink: /docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/
+---
+
+# ConfluencePS.ContentLabelSet
+
+## SYNOPSIS
+Defines an object for ContentLabelSets in Confluence.
+
+## SYNTAX
+
+```powershell
+New-Object -TypeName ConfluencePS.ContentLabelSet [-Property @{}]
+
+[ConfluencePS.ContentLabelSet]@{}
+```
+
+## DESCRIPTION
+The `ContentLabelSet` is an object that describes the `Label`s that are assigned to a `Page`.
+
+## REFERENCES
+_This class is not used by any other class._
+
+## CONSTRUCTORS
+_This class does not have a constructor._
+
+## PROPERTIES
+
+### Page
+Contains the `Page` that is being described.
+
+```yaml
+Type: ConfluencePS.Page
+Required: True
+Default value: None
+```
+
+### Labels
+Contains a list of `Label`s that are assigned to the `Page`.
+
+```yaml
+Type: ConfluencePS.Label
+Required: False
+Default value: None
+```
+
+## METHODS
+
+### ToString()
+_No behavior of casting to string is defined._

docs/classes/ConfluencePS.Icon.md

@@ -0,0 +1,74 @@
+---
+layout: documentation
+permalink: /docs/ConfluencePS/classes/ConfluencePS.Icon/
+---
+
+# ConfluencePS.Icon
+
+## SYNOPSIS
+Defines an object for Icons in Confluence.
+
+## SYNTAX
+
+```powershell
+New-Object -TypeName ConfluencePS.Icon [-Property @{}]
+
+[ConfluencePS.Icon]@{}
+```
+
+## DESCRIPTION
+The `Icon` is an object that describes images in Confluence.
+It is important to note, that the path to the resource is not absolute; but relative to the BaseUri of the Confluence server.
+
+## REFERENCES
+The following classes use `Icon` for their properties:
+- [`ConfluencePS.User`](/docs/ConfluencePS/classes/ConfluencePS.User/)
+- [`ConfluencePS.Space`](/docs/ConfluencePS/classes/ConfluencePS.Space/)
+
+## CONSTRUCTORS
+_This class does not have a constructor._
+
+## PROPERTIES
+
+### Path
+The Path describes the path to the `Icon` resource relative to the BaseUri.
+
+```yaml
+Type: String
+Required: True
+Default value: None
+```
+
+### Width
+The Width describes the width of the `Icon` resource in pixels.
+
+```yaml
+Type: Int32
+Required: False
+Default value: None
+```
+
+### Height
+The Height describes the height of the `Icon` resource in pixels.
+
+```yaml
+Type: Int32
+Required: False
+Default value: None
+```
+
+### IsDefault
+The IsDefault describes if the used `Icon` resource is the default icon from the server.
+
+```yaml
+Type: Boolean
+Required: False
+Default value: False
+```
+
+## METHODS
+
+### ToString()
+The method for casting an object of this class to string is overwritten.
+
+When cast to string, this will return the `Path` property's value.

docs/classes/ConfluencePS.Label.md

@@ -0,0 +1,65 @@
+---
+layout: documentation
+permalink: /docs/ConfluencePS/classes/ConfluencePS.Label/
+---
+
+# ConfluencePS.Label
+
+## SYNOPSIS
+Defines an object for Labels in Confluence.
+
+## SYNTAX
+
+```powershell
+New-Object -TypeName ConfluencePS.Label [-Property @{}]
+
+[ConfluencePS.Label]@{}
+```
+
+## DESCRIPTION
+**fix**The `Label` is an object that describes labels in Confluence.
+
+## REFERENCES
+The following classes use `User` for their properties:
+- [`ConfluencePS.ContentLabelSet`](/docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/)
+
+## CONSTRUCTORS
+_This class does not have a constructor._
+
+## PROPERTIES
+
+### Id
+The Id is the identifier of a `Label` used by the Confluence server internally.
+
+_This value can't be changed and is assigned by the server._
+
+```yaml
+Type: Int32
+Required: True
+Default value: None
+```
+
+### Prefix
+_description missing_
+
+```yaml
+Type: String
+Required: True
+Default value: global
+```
+
+### Name
+The name of the `Label`.
+
+```yaml
+Type: String
+Required: True
+Default value: None
+```
+
+## METHODS
+
+### ToString()
+The method for casting an object of this class to string is overwritten.
+
+When cast to string, this will return the `Name` property's value.

docs/classes/ConfluencePS.Page.md

@@ -0,0 +1,127 @@
+---
+layout: documentation
+permalink: /docs/ConfluencePS/classes/ConfluencePS.Page/
+---
+
+# ConfluencePS.Page
+
+## SYNOPSIS
+Defines an object for Pages in Confluence.
+
+## SYNTAX
+
+```powershell
+New-Object -TypeName ConfluencePS.Page [-Property @{}]
+
+[ConfluencePS.Page]@{}
+```
+
+## DESCRIPTION
+**fix**The `Page` is an object that describes pages in Confluence.
+
+## REFERENCES
+The following classes use `Page` for their properties:
+- [`ConfluencePS.ContentLabelSet`](/docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/)
+- [`ConfluencePS.Page`](/docs/ConfluencePS/classes/ConfluencePS.Page/)
+- [`ConfluencePS.Space`](/docs/ConfluencePS/classes/ConfluencePS.Space/)
+
+## CONSTRUCTORS
+_This class does not have a constructor._
+
+## PROPERTIES
+
+### Id
+The Id is the unique identifier of the `Page`.
+
+_This value can't be changed and is assigned by the server._
+
+```yaml
+Type: Int32
+Required: True
+Default value: None
+```
+
+### Status
+The Status describes the current status of the `Page`.
+
+Possible values are: `current`, `trashed` and `draft`.
+
+```yaml
+Type: String
+Required: True
+Default value: current
+```
+
+### Title
+The Name / Title of the `Page`.
+
+```yaml
+Type: String
+Required: True
+Default value: None
+```
+
+### Space
+The Space in which the `Page` is in.
+
+```yaml
+Type: ConfluencePS.Space
+Required: True
+Default value: None
+```
+
+### Version
+Contains the information about the latest version of the `Page`.
+
+Values can be `global` or `personal`.
+
+```yaml
+Type: ConfluencePS.Version
+Required: True
+Default value: None
+```
+
+### Body
+The Content / Body of the `Page`.
+
+_The content is in Confluence's stroage format, which must be a valid XHTML string._
+
+```yaml
+Type: String
+Required: True
+Default value: null
+```
+
+### Ancestors
+Contains the hierarchy of the `Page` in the navigation by describing it's ancestors / parent pages.
+
+```yaml
+Type: ConfluencePS.Page
+Required: False
+Default value: None
+```
+
+### URL
+Contains the URL under which the `Page` is accessible.
+
+```yaml
+Type: String
+Required: True
+Default value: None
+```
+
+### ShortURL
+Contains a shortened URL under which the `Page` is accessible.
+
+```yaml
+Type: String
+Required: True
+Default value: None
+```
+
+## METHODS
+
+### ToString()
+The method for casting an object of this class to string is overwritten.
+
+When cast to string, this will return `[$Id] $Title`.