Skip to content

Commit

Permalink
Add basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
markatk committed Nov 26, 2018
1 parent c52faa7 commit edf0796
Show file tree
Hide file tree
Showing 113 changed files with 58,687 additions and 5 deletions.
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
/api/AlternateLife*
/api/.manifest
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "ragemp-dotnet-core"]
path = ragemp-dotnet-core
url = https://github.com/AlternateLife/ragemp-dotnet-core.git
2 changes: 2 additions & 0 deletions api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
167 changes: 167 additions & 0 deletions api/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
### YamlMime:TableOfContent
- uid: AlternateLife.RageMP.Net.Data
name: AlternateLife.RageMP.Net.Data
items:
- uid: AlternateLife.RageMP.Net.Data.ClothData
name: ClothData
- uid: AlternateLife.RageMP.Net.Data.ColorRgba
name: ColorRgba
- uid: AlternateLife.RageMP.Net.Data.HeadBlendData
name: HeadBlendData
- uid: AlternateLife.RageMP.Net.Data.HeadOverlayData
name: HeadOverlayData
- uid: AlternateLife.RageMP.Net.Data.PaintData
name: PaintData
- uid: AlternateLife.RageMP.Net.Data.PropData
name: PropData
- uid: AlternateLife.RageMP.Net.Data.TimeData
name: TimeData
- uid: AlternateLife.RageMP.Net.Enums
name: AlternateLife.RageMP.Net.Enums
items:
- uid: AlternateLife.RageMP.Net.Enums.AnimationFlags
name: AnimationFlags
- uid: AlternateLife.RageMP.Net.Enums.ClothSlot
name: ClothSlot
- uid: AlternateLife.RageMP.Net.Enums.ColshapeType
name: ColshapeType
- uid: AlternateLife.RageMP.Net.Enums.DeathReason
name: DeathReason
- uid: AlternateLife.RageMP.Net.Enums.DisconnectReason
name: DisconnectReason
- uid: AlternateLife.RageMP.Net.Enums.EntityType
name: EntityType
- uid: AlternateLife.RageMP.Net.Enums.MarkerType
name: MarkerType
- uid: AlternateLife.RageMP.Net.Enums.MaterialType
name: MaterialType
- uid: AlternateLife.RageMP.Net.Enums.PedHash
name: PedHash
- uid: AlternateLife.RageMP.Net.Enums.PropSlot
name: PropSlot
- uid: AlternateLife.RageMP.Net.Enums.VehicleHash
name: VehicleHash
- uid: AlternateLife.RageMP.Net.Enums.WeaponHash
name: WeaponHash
- uid: AlternateLife.RageMP.Net.Exceptions
name: AlternateLife.RageMP.Net.Exceptions
items:
- uid: AlternateLife.RageMP.Net.Exceptions.EntityDeletedException
name: EntityDeletedException
- uid: AlternateLife.RageMP.Net.Interfaces
name: AlternateLife.RageMP.Net.Interfaces
items:
- uid: AlternateLife.RageMP.Net.Interfaces.IBlip
name: IBlip
- uid: AlternateLife.RageMP.Net.Interfaces.IBlipPool
name: IBlipPool
- uid: AlternateLife.RageMP.Net.Interfaces.ICheckpoint
name: ICheckpoint
- uid: AlternateLife.RageMP.Net.Interfaces.ICheckpointPool
name: ICheckpointPool
- uid: AlternateLife.RageMP.Net.Interfaces.IColshape
name: IColshape
- uid: AlternateLife.RageMP.Net.Interfaces.IColshapePool
name: IColshapePool
- uid: AlternateLife.RageMP.Net.Interfaces.IConfig
name: IConfig
- uid: AlternateLife.RageMP.Net.Interfaces.IEntity
name: IEntity
- uid: AlternateLife.RageMP.Net.Interfaces.IEventScripting
name: IEventScripting
- uid: AlternateLife.RageMP.Net.Interfaces.ILogger
name: ILogger
- uid: AlternateLife.RageMP.Net.Interfaces.IMarker
name: IMarker
- uid: AlternateLife.RageMP.Net.Interfaces.IMarkerPool
name: IMarkerPool
- uid: AlternateLife.RageMP.Net.Interfaces.IObject
name: IObject
- uid: AlternateLife.RageMP.Net.Interfaces.IObjectPool
name: IObjectPool
- uid: AlternateLife.RageMP.Net.Interfaces.IPlayer
name: IPlayer
- uid: AlternateLife.RageMP.Net.Interfaces.IPlayerPool
name: IPlayerPool
- uid: AlternateLife.RageMP.Net.Interfaces.IPool`1
name: IPool<T>
name.vb: IPool(Of T)
- uid: AlternateLife.RageMP.Net.Interfaces.ITextLabel
name: ITextLabel
- uid: AlternateLife.RageMP.Net.Interfaces.ITextLabelPool
name: ITextLabelPool
- uid: AlternateLife.RageMP.Net.Interfaces.IVehicle
name: IVehicle
- uid: AlternateLife.RageMP.Net.Interfaces.IVehiclePool
name: IVehiclePool
- uid: AlternateLife.RageMP.Net.Interfaces.IWorld
name: IWorld
- uid: AlternateLife.RageMP.Net.Scripting
name: AlternateLife.RageMP.Net.Scripting
items:
- uid: AlternateLife.RageMP.Net.Scripting.EntityCreatedDelegate
name: EntityCreatedDelegate
- uid: AlternateLife.RageMP.Net.Scripting.EntityDestroyedDelegate
name: EntityDestroyedDelegate
- uid: AlternateLife.RageMP.Net.Scripting.EntityModelChangeDelegate
name: EntityModelChangeDelegate
- uid: AlternateLife.RageMP.Net.Scripting.IResource
name: IResource
- uid: AlternateLife.RageMP.Net.Scripting.MP
name: MP
- uid: AlternateLife.RageMP.Net.Scripting.PlayerChatDelegate
name: PlayerChatDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerCommandDelegate
name: PlayerCommandDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerCreateWaypointDelegate
name: PlayerCreateWaypointDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerDamageDelegate
name: PlayerDamageDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerDeathDelegate
name: PlayerDeathDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerEnterCheckpointDelegate
name: PlayerEnterCheckpointDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerEnterColshapeDelegate
name: PlayerEnterColshapeDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerEnterVehicleDelegate
name: PlayerEnterVehicleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerExitCheckpointDelegate
name: PlayerExitCheckpointDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerExitColshapeDelegate
name: PlayerExitColshapeDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerExitVehicleDelegate
name: PlayerExitVehicleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerJoinDelegate
name: PlayerJoinDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerQuitDelegate
name: PlayerQuitDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerReachWaypointDelegate
name: PlayerReachWaypointDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerReadyDelegate
name: PlayerReadyDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerRemoteEventDelegate
name: PlayerRemoteEventDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerSpawnDelegate
name: PlayerSpawnDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerStartEnterVehicleDelegate
name: PlayerStartEnterVehicleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerStartExitVehicleDelegate
name: PlayerStartExitVehicleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerStreamInDelegate
name: PlayerStreamInDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerStreamOutDelegate
name: PlayerStreamOutDelegate
- uid: AlternateLife.RageMP.Net.Scripting.PlayerWeaponChangeDelegate
name: PlayerWeaponChangeDelegate
- uid: AlternateLife.RageMP.Net.Scripting.TickDelegate
name: TickDelegate
- uid: AlternateLife.RageMP.Net.Scripting.VehicleDamageDelegate
name: VehicleDamageDelegate
- uid: AlternateLife.RageMP.Net.Scripting.VehicleDeathDelegate
name: VehicleDeathDelegate
- uid: AlternateLife.RageMP.Net.Scripting.VehicleHornToggleDelegate
name: VehicleHornToggleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.VehicleSirenToggleDelegate
name: VehicleSirenToggleDelegate
- uid: AlternateLife.RageMP.Net.Scripting.VehicleTrailerAttachedDelegate
name: VehicleTrailerAttachedDelegate
51 changes: 51 additions & 0 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
{
"metadata": [
{
"src": [
{
"files": [
"ragemp-dotnet-core/src/AlternateLife.RageMP.Net/AlternateLife.RageMP.Net.csproj"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"dest": "docs",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
Loading

0 comments on commit edf0796

Please sign in to comment.