From e8bc57c2321d5f38ba48854b129db776f1c03e90 Mon Sep 17 00:00:00 2001 From: Bret Curtis Date: Thu, 16 Feb 2017 16:03:43 +0100 Subject: [PATCH] add the rest of the openmw source documentation --- docs/source/source/openmw/index.rst | 11 ++ docs/source/source/openmw/mwinput.rst | 5 + docs/source/source/openmw/mwmechanics.rst | 137 ++++++++++++++++++++++ docs/source/source/openmw/mwphysics.rst | 15 +++ docs/source/source/openmw/mwrender.rst | 77 ++++++++++++ docs/source/source/openmw/mwscript.rst | 65 ++++++++++ docs/source/source/openmw/mwsound.rst | 29 +++++ docs/source/source/openmw/mwstate.rst | 11 ++ docs/source/source/openmw/mwworld.rst | 132 +++++++++++++++++++++ 9 files changed, 482 insertions(+) create mode 100644 docs/source/source/openmw/mwinput.rst create mode 100644 docs/source/source/openmw/mwmechanics.rst create mode 100644 docs/source/source/openmw/mwphysics.rst create mode 100644 docs/source/source/openmw/mwrender.rst create mode 100644 docs/source/source/openmw/mwscript.rst create mode 100644 docs/source/source/openmw/mwsound.rst create mode 100644 docs/source/source/openmw/mwstate.rst create mode 100644 docs/source/source/openmw/mwworld.rst diff --git a/docs/source/source/openmw/index.rst b/docs/source/source/openmw/index.rst index b602c39a69..5367995de8 100644 --- a/docs/source/source/openmw/index.rst +++ b/docs/source/source/openmw/index.rst @@ -8,6 +8,17 @@ OpenMW Source Documentation mwclass mwdialogue mwgui + mwinput + mwmechanics + mwphysics + mwrender + mwscript + mwsound + mwstate + mwworld .. autodoxygenfile:: engine.hpp :project: openmw + +.. autodoxygenfile:: doc.hpp + :project: openmw \ No newline at end of file diff --git a/docs/source/source/openmw/mwinput.rst b/docs/source/source/openmw/mwinput.rst new file mode 100644 index 0000000000..b24d8dfdbe --- /dev/null +++ b/docs/source/source/openmw/mwinput.rst @@ -0,0 +1,5 @@ +./mwinput +######### + +.. autodoxygenfile:: mwinput/inputmanagerimp.hpp + :project: openmw \ No newline at end of file diff --git a/docs/source/source/openmw/mwmechanics.rst b/docs/source/source/openmw/mwmechanics.rst new file mode 100644 index 0000000000..3427b712af --- /dev/null +++ b/docs/source/source/openmw/mwmechanics.rst @@ -0,0 +1,137 @@ +./mwmechanics +############# + +.. autodoxygenfile:: mwmechanics/activespells.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/actor.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/actors.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/actorutil.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aiactivate.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aiavoiddoor.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aicombataction.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aicombat.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aiescort.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aiface.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aifollow.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aipackage.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aipursue.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aisequence.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aistate.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aitravel.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/aiwander.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/alchemy.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/autocalcspell.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/character.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/combat.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/coordinateconverter.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/creaturestats.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/difficultyscaling.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/disease.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/drawstate.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/enchanting.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/levelledlist.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/magiceffects.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/mechanicsmanagerimp.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/movement.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/npcstats.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/objects.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/obstacle.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/pathfinding.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/pathgrid.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/pickpocket.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/repair.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/security.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/spellcasting.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/spells.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/stat.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/steering.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/summoning.hpp + :project: openmw + +.. autodoxygenfile:: mwmechanics/trading.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwphysics.rst b/docs/source/source/openmw/mwphysics.rst new file mode 100644 index 0000000000..6eebab4d99 --- /dev/null +++ b/docs/source/source/openmw/mwphysics.rst @@ -0,0 +1,15 @@ +./mwphysics +########### + +.. autodoxygenfile:: mwphysics/actor.hpp + :project: openmw + +.. autodoxygenfile:: mwphysics/collisiontype.hpp + :project: openmw + +.. autodoxygenfile:: mwphysics/convert.hpp + :project: openmw + +.. autodoxygenfile:: mwphysics/physicssystem.hpp + :project: openmw + diff --git a/docs/source/source/openmw/mwrender.rst b/docs/source/source/openmw/mwrender.rst new file mode 100644 index 0000000000..d284f65864 --- /dev/null +++ b/docs/source/source/openmw/mwrender.rst @@ -0,0 +1,77 @@ +./mwrender +########## + +.. autodoxygenfile:: mwrender/actoranimation.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/animation.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/bulletdebugdraw.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/camera.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/cell.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/characterpreview.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/creatureanimation.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/effectmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/globalmap.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/localmap.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/npcanimation.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/objects.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/pathgrid.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/renderbin.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/renderinginterface.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/renderingmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/rendermode.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/ripplesimulation.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/rotatecontroller.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/sky.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/terrainstorage.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/util.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/vismask.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/water.hpp + :project: openmw + +.. autodoxygenfile:: mwrender/weaponanimation.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwscript.rst b/docs/source/source/openmw/mwscript.rst new file mode 100644 index 0000000000..8db8f40e25 --- /dev/null +++ b/docs/source/source/openmw/mwscript.rst @@ -0,0 +1,65 @@ +./mwscript +########## + +.. autodoxygenfile:: mwscript/aiextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/animationextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/cellextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/compilercontext.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/consoleextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/containerextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/controlextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/dialogueextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/extensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/globalscripts.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/guiextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/interpretercontext.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/locals.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/miscextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/ref.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/scriptmanagerimp.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/skyextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/soundextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/statsextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/transformationextensions.hpp + :project: openmw + +.. autodoxygenfile:: mwscript/userextensions.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwsound.rst b/docs/source/source/openmw/mwsound.rst new file mode 100644 index 0000000000..d4fcb0e6bd --- /dev/null +++ b/docs/source/source/openmw/mwsound.rst @@ -0,0 +1,29 @@ +./mwsound +######### + +.. autodoxygenfile:: mwsound/ffmpeg_decoder.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/loudness.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/movieaudiofactory.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/openal_output.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/sound_buffer.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/sound_decoder.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/sound.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/soundmanagerimp.hpp + :project: openmw + +.. autodoxygenfile:: mwsound/sound_output.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwstate.rst b/docs/source/source/openmw/mwstate.rst new file mode 100644 index 0000000000..2618c6ff00 --- /dev/null +++ b/docs/source/source/openmw/mwstate.rst @@ -0,0 +1,11 @@ +./mwstate +######### + +.. autodoxygenfile:: mwstate/character.hpp + :project: openmw + +.. autodoxygenfile:: mwstate/charactermanager.hpp + :project: openmw + +.. autodoxygenfile:: mwstate/statemanagerimp.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwworld.rst b/docs/source/source/openmw/mwworld.rst new file mode 100644 index 0000000000..21026b3e24 --- /dev/null +++ b/docs/source/source/openmw/mwworld.rst @@ -0,0 +1,132 @@ +./mwworld +######### + +.. autodoxygenfile:: mwworld/actionalchemy.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionapply.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actiondoor.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actioneat.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionequip.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/action.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionopen.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionread.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionrepair.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionsoulgem.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actiontake.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actiontalk.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actionteleport.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/actiontrap.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cellpreloader.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cellref.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cellreflist.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cells.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cellstore.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/cellvisitors.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/class.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/containerstore.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/contentloader.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/customdata.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/esmloader.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/esmstore.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/failedaction.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/globals.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/inventorystore.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/livecellref.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/localscripts.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/manualref.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/nullaction.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/player.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/projectilemanager.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/ptr.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/recordcmp.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/refdata.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/scene.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/store.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/timestamp.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/weather.hpp + :project: openmw + +.. autodoxygenfile:: mwworld/worldimp.hpp + :project: openmw +