KlusterKite.API.Attributes.ApiDescriptionAttribute Class Reference

Describes type (class) to published api More...

Inheritance diagram for KlusterKite.API.Attributes.ApiDescriptionAttribute:

Public Member Functions
	ApiDescriptionAttribute ()
	Initializes a new instance of the ApiDescriptionAttribute class. More...
	ApiDescriptionAttribute (string description)
	Initializes a new instance of the ApiDescriptionAttribute class. More...
string	GetName (MemberInfo member)
	Creates name for the type field More...
string	GetName (Type type)
	Creates name for the type More...

Static Public Member Functions
static Type	CheckType (Type type, Type typeToCheck)
	Checks the interface implementation More...
static string	GetParameterName (ParameterInfo parameter)
	Creates name for the method parameter More...
static string	GetTypeName (Type type)
	Creates name for the type More...
static string	ToCamelCase (string name)
	Converts string to camel case More...

Properties
string	Description [get, set]
	Gets or sets the description to publish More...
string	Name [get, set]
	Gets or sets the published property / method name More...

Detailed Description

Describes type (class) to published api

Definition at line 21 of file ApiDescriptionAttribute.cs.

Constructor & Destructor Documentation

ApiDescriptionAttribute() [1/2]

KlusterKite.API.Attributes.ApiDescriptionAttribute.ApiDescriptionAttribute

(

)

Initializes a new instance of the ApiDescriptionAttribute class.

Definition at line 26 of file ApiDescriptionAttribute.cs.

ApiDescriptionAttribute() [2/2]

KlusterKite.API.Attributes.ApiDescriptionAttribute.ApiDescriptionAttribute

(

string

description

)

Initializes a new instance of the ApiDescriptionAttribute class.

Parameters

description

The description.

Definition at line 36 of file ApiDescriptionAttribute.cs.

Member Function Documentation

CheckType()

static Type KlusterKite.API.Attributes.ApiDescriptionAttribute.CheckType ( Type  type, Type  typeToCheck  )

static

Checks the interface implementation

Parameters

type	The type to check
typeToCheck	The type of an interface

Returns

The interface or null

Definition at line 57 of file ApiDescriptionAttribute.cs.

GetName() [1/2]

string KlusterKite.API.Attributes.ApiDescriptionAttribute.GetName

(

MemberInfo

member

)

Creates name for the type field

Parameters

member

The type member

Returns

The member name

Definition at line 154 of file ApiDescriptionAttribute.cs.

GetName() [2/2]

string KlusterKite.API.Attributes.ApiDescriptionAttribute.GetName

(

Type

type

)

Creates name for the type

Parameters

type

The type

Returns

The type name

Definition at line 164 of file ApiDescriptionAttribute.cs.

GetParameterName()

static string KlusterKite.API.Attributes.ApiDescriptionAttribute.GetParameterName ( ParameterInfo  parameter )

static

Creates name for the method parameter

Parameters

parameter

The type

Returns

The type name

Definition at line 103 of file ApiDescriptionAttribute.cs.

GetTypeName()

static string KlusterKite.API.Attributes.ApiDescriptionAttribute.GetTypeName ( Type  type )

static

Creates name for the type

Parameters

type

The type

Returns

The type name

Definition at line 114 of file ApiDescriptionAttribute.cs.

ToCamelCase()

static string KlusterKite.API.Attributes.ApiDescriptionAttribute.ToCamelCase ( string  name )

static

Converts string to camel case

Parameters

name	The property / method name

Returns

The name in camel case

Definition at line 134 of file ApiDescriptionAttribute.cs.

Property Documentation

Description

string KlusterKite.API.Attributes.ApiDescriptionAttribute.Description

getset

Gets or sets the description to publish

Definition at line 44 of file ApiDescriptionAttribute.cs.

Name

string KlusterKite.API.Attributes.ApiDescriptionAttribute.Name

getset

Gets or sets the published property / method name

Definition at line 49 of file ApiDescriptionAttribute.cs.

---

The documentation for this class was generated from the following file:

• KlusterKite.API/KlusterKite.API.Attributes/ApiDescriptionAttribute.cs