Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(API): add auto-generated API documentation #31

Merged
merged 1 commit into from Jul 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
@@ -1,6 +1,7 @@
[Ll]ibrary/
[Tt]emp/
[Oo]bj/
[Oo]bj.meta
[Bb]uild/
[Bb]uilds/
[Ll]ogs/
Expand Down Expand Up @@ -32,4 +33,4 @@ ExportedObj/

# System files
.DS_Store
*.swp
*.swp
8 changes: 8 additions & 0 deletions Documentation/API.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Documentation/API/Interactables.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Documentation/API/Interactables/Event.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Documentation/API/Interactables/Event/Proxy.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

@@ -0,0 +1,19 @@
# Class InteractableFacadeEventProxyEmitter.UnityEvent

Defines the event with the specified state.

##### Inheritance

* System.Object
* InteractableFacadeEventProxyEmitter.UnityEvent

###### **Namespace**: [Tilia.Interactions.Interactables.Interactables.Event.Proxy]

##### Syntax

```
[Serializable]
public class UnityEvent : InteractableFacadeEventProxyEmitter.UnityEvent<InteractableFacade>
```

[Tilia.Interactions.Interactables.Interactables.Event.Proxy]: README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

@@ -0,0 +1,52 @@
# Class InteractableFacadeEventProxyEmitter

Emits a UnityEvent with an [InteractableFacade] payload whenever the Receive method is called.

## Contents

* [Inheritance]
* [Namespace]
* [Syntax]
* [Methods]
* [GetTargetToCheck()]

## Details

##### Inheritance

* System.Object
* InteractableFacadeEventProxyEmitter

##### Namespace

* [Tilia.Interactions.Interactables.Interactables.Event.Proxy]

##### Syntax

```
public class InteractableFacadeEventProxyEmitter : RestrictableSingleEventProxyEmitter<InteractableFacade, InteractableFacadeEventProxyEmitter.UnityEvent>
```

### Methods

#### GetTargetToCheck()

##### Declaration

```
protected override object GetTargetToCheck()
```

##### Returns

| Type | Description |
| --- | --- |
| System.Object | n/a |

[InteractableFacade]: ../../../Interactables/InteractableFacade.md
[Tilia.Interactions.Interactables.Interactables.Event.Proxy]: README.md
[Inheritance]: #Inheritance
[Namespace]: #Namespace
[Syntax]: #Syntax
[Methods]: #Methods
[GetTargetToCheck()]: #GetTargetToCheck

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions Documentation/API/Interactables/Event/Proxy/README.md
@@ -0,0 +1,15 @@
# Namespace Tilia.Interactions.Interactables.Interactables.Event.Proxy

### Classes

#### [InteractableFacadeEventProxyEmitter]

Emits a UnityEvent with an [InteractableFacade] payload whenever the Receive method is called.

#### [InteractableFacadeEventProxyEmitter.UnityEvent]

Defines the event with the specified state.

[InteractableFacadeEventProxyEmitter]: InteractableFacadeEventProxyEmitter.md
[InteractableFacade]: ../../../Interactables/InteractableFacade.md
[InteractableFacadeEventProxyEmitter.UnityEvent]: InteractableFacadeEventProxyEmitter.UnityEvent.md
7 changes: 7 additions & 0 deletions Documentation/API/Interactables/Event/Proxy/README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Documentation/API/Interactables/Grab.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Documentation/API/Interactables/Grab/Action.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

169 changes: 169 additions & 0 deletions Documentation/API/Interactables/Grab/Action/GrabInteractableAction.md
@@ -0,0 +1,169 @@
# Class GrabInteractableAction

Describes an action to perform when a Grab Process is executed.

## Contents

* [Inheritance]
* [Namespace]
* [Syntax]
* [Properties]
* [GrabSetup]
* [InputActiveCollisionConsumer]
* [InputGrabReceived]
* [InputGrabSetup]
* [InputUngrabReceived]
* [InputUngrabReset]
* [Methods]
* [NotifyGrab(GameObject)]
* [NotifyUngrab(GameObject)]
* [OnAfterGrabSetupChange()]

## Details

##### Inheritance

* System.Object
* GrabInteractableAction
* [GrabInteractableControlDirectionAction]
* [GrabInteractableFollowAction]
* [GrabInteractableScaleAction]
* [GrabInteractableSwapAction]

##### Namespace

* [Tilia.Interactions.Interactables.Interactables.Grab.Action]

##### Syntax

```
public class GrabInteractableAction : MonoBehaviour
```

### Properties

#### GrabSetup

The internal setup for the grab action.

##### Declaration

```
public GrabInteractableConfigurator GrabSetup { get; set; }
```

#### InputActiveCollisionConsumer

The input ActiveCollisionConsumerEventProxyEmitter for the grab action.

##### Declaration

```
public ActiveCollisionConsumerEventProxyEmitter InputActiveCollisionConsumer { get; protected set; }
```

#### InputGrabReceived

The input GameObjectEventProxyEmitter for the grab action.

##### Declaration

```
public GameObjectEventProxyEmitter InputGrabReceived { get; protected set; }
```

#### InputGrabSetup

The input GameObjectEventProxyEmitter for any pre setup on grab.

##### Declaration

```
public GameObjectEventProxyEmitter InputGrabSetup { get; protected set; }
```

#### InputUngrabReceived

The input GameObjectEventProxyEmitter for the grab action.

##### Declaration

```
public GameObjectEventProxyEmitter InputUngrabReceived { get; protected set; }
```

#### InputUngrabReset

The input GameObjectEventProxyEmitter for any post reset on ungrab.

##### Declaration

```
public GameObjectEventProxyEmitter InputUngrabReset { get; protected set; }
```

### Methods

#### NotifyGrab(GameObject)

Notifies that the Interactable is being grabbed.

##### Declaration

```
public virtual void NotifyGrab(GameObject data)
```

##### Parameters

| Type | Name | Description |
| --- | --- | --- |
| GameObject | data | The grabbing object. |

#### NotifyUngrab(GameObject)

Notifies that the Interactable is no longer being grabbed.

##### Declaration

```
public virtual void NotifyUngrab(GameObject data)
```

##### Parameters

| Type | Name | Description |
| --- | --- | --- |
| GameObject | data | The previous grabbing object. |

#### OnAfterGrabSetupChange()

Called after [GrabSetup] has been changed.

##### Declaration

```
protected virtual void OnAfterGrabSetupChange()
```

[GrabInteractableControlDirectionAction]: GrabInteractableControlDirectionAction.md
[GrabInteractableFollowAction]: GrabInteractableFollowAction.md
[GrabInteractableScaleAction]: GrabInteractableScaleAction.md
[GrabInteractableSwapAction]: GrabInteractableSwapAction.md
[Tilia.Interactions.Interactables.Interactables.Grab.Action]: README.md
[GrabInteractableConfigurator]: ../../../Interactables/Grab/GrabInteractableConfigurator.md
[GrabSetup]: GrabInteractableAction.md#GrabSetup
[Inheritance]: #Inheritance
[Namespace]: #Namespace
[Syntax]: #Syntax
[Properties]: #Properties
[GrabSetup]: #GrabSetup
[InputActiveCollisionConsumer]: #InputActiveCollisionConsumer
[InputGrabReceived]: #InputGrabReceived
[InputGrabSetup]: #InputGrabSetup
[InputUngrabReceived]: #InputUngrabReceived
[InputUngrabReset]: #InputUngrabReset
[Methods]: #Methods
[NotifyGrab(GameObject)]: #NotifyGrabGameObject
[NotifyUngrab(GameObject)]: #NotifyUngrabGameObject
[OnAfterGrabSetupChange()]: #OnAfterGrabSetupChange

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.