diff --git a/apps/openmw/mwrender/animation.cpp b/apps/openmw/mwrender/animation.cpp index ec28d4295..30d3a049e 100644 --- a/apps/openmw/mwrender/animation.cpp +++ b/apps/openmw/mwrender/animation.cpp @@ -179,15 +179,6 @@ namespace { } - virtual void apply(osg::Group& node) - { - traverse(node); - } - virtual void apply(osg::MatrixTransform& node) - { - traverse(node); - } - void remove() { for (RemoveVec::iterator it = mToRemove.begin(); it != mToRemove.end(); ++it) @@ -209,6 +200,15 @@ namespace applyImpl(drw); } + virtual void apply(osg::Group& node) + { + traverse(node); + } + virtual void apply(osg::MatrixTransform& node) + { + traverse(node); + } + void applyImpl(osg::Node& node) { osg::NodePath::iterator parent = getNodePath().end()-2; @@ -240,6 +240,15 @@ namespace applyImpl(drw); } + virtual void apply(osg::Group& node) + { + traverse(node); + } + virtual void apply(osg::MatrixTransform& node) + { + traverse(node); + } + void applyImpl(osg::Node& node) { const std::string toFind = "tri bip"; diff --git a/docs/source/_static/.keep b/docs/source/_static/.keep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/source/conf.py b/docs/source/conf.py index 12c6f91a7..63016d53a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,9 +11,9 @@ # # All configuration values have a default; values that are commented out # serve to show the default. - -import sys +import glob import os +import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -21,6 +21,12 @@ import os project_root = os.path.abspath('../../') sys.path.insert(0, project_root) + +def insensitive_glob(pattern): + def either(c): + return '[%s%s]' % (c.lower(), c.upper()) if c.isalpha() else c + return glob.glob(''.join(map(either, pattern))) + # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -35,17 +41,27 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', - 'breathe', ] +try: + import breathe + extensions.append('breathe') +except ImportError: + print("WARNING: Unable to import breathe, code documentation won't be generated.") + # Where breathe can find the source files +openmw_path = os.path.join(project_root, "apps", "openmw") +openmw_sub_dirs = os.walk(openmw_path).next()[1] +openmw_headers = insensitive_glob(os.path.join(openmw_path, "*.hpp")) +for dir in openmw_sub_dirs: + openmw_headers += insensitive_glob(os.path.join(openmw_path, dir, "*.hpp")) + +# massage the headers to get the relative path needed +openmw_headers = [os.path.relpath(x, openmw_path) for x in openmw_headers] + breathe_projects_source = { - "openmw": (project_root+"/apps/openmw", ["engine.hpp", - "mwbase/dialoguemanager.hpp", "mwbase/environment.hpp", - "mwbase/inputmanager.hpp", "mwbase/journal.hpp", "mwbase/mechanicsmanager.hpp", - "mwbase/scriptmanager.hpp", "mwbase/soundmanager.hpp", "mwbase/statemanager.hpp", - "mwbase/windowmanager.hpp", "mwbase/world.hpp"]) - } + "openmw": (openmw_path, openmw_headers) +} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -71,10 +87,16 @@ copyright = u'2016, OpenMW Team' # The short X.Y version. # The full version, including alpha/beta/rc tags. -from parse_cmake import parsing -cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read() -cmake_data = parsing.parse(cmake_raw) -release = version = int(cmake_data[24][1][1].contents), int(cmake_data[25][1][1].contents), int(cmake_data[26][1][1].contents) +try: + from parse_cmake import parsing + cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read() + cmake_data = parsing.parse(cmake_raw) + release = version = '.'.join([cmake_data[24][1][1].contents, + cmake_data[25][1][1].contents, + cmake_data[26][1][1].contents]) +except ImportError: + release = "UNRELEASED" + print("WARNING: Unable to import parse_cmake, version will be set to: {0}.".format(release)) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -150,7 +172,7 @@ html_theme = 'default' # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static', - 'openmw-cs/_static' + 'manuals/openmw-cs/_static' ] # Add any extra paths that contain custom files (such as robots.txt or diff --git a/docs/source/index.rst b/docs/source/index.rst index fdcb6ddaf..f51cda909 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,19 +1,18 @@ +Welcome to OpenMW's Documentation! +================================== -Welcome to OpenMW's documentation! -===================================== - -Components ----------- +Sections +-------- .. toctree:: :maxdepth: 2 - openmw/index - openmw-cs/index - openmw-mods/index + manuals/index + reference/index + source/index -Indices and tables +Indices and Tables ================== * :ref:`genindex` diff --git a/docs/source/manuals/index.rst b/docs/source/manuals/index.rst new file mode 100644 index 000000000..2bf1fff5e --- /dev/null +++ b/docs/source/manuals/index.rst @@ -0,0 +1,7 @@ +User Manuals +============ + +.. toctree:: + :maxdepth: 2 + + openmw-cs/index diff --git a/docs/source/openmw-cs/_static/images/chapter-1/add-record.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/add-record.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/add-record.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/add-record.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/edit-record.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/edit-record.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/edit-record.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/edit-record.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/new-project.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/new-project.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/new-project.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/new-project.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/objects.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/objects.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/objects.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/objects.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/opening-dialogue.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/opening-dialogue.png diff --git a/docs/source/openmw-cs/files-and-directories.rst b/docs/source/manuals/openmw-cs/files-and-directories.rst similarity index 100% rename from docs/source/openmw-cs/files-and-directories.rst rename to docs/source/manuals/openmw-cs/files-and-directories.rst diff --git a/docs/source/openmw-cs/foreword.rst b/docs/source/manuals/openmw-cs/foreword.rst similarity index 100% rename from docs/source/openmw-cs/foreword.rst rename to docs/source/manuals/openmw-cs/foreword.rst diff --git a/docs/source/openmw-cs/index.rst b/docs/source/manuals/openmw-cs/index.rst similarity index 51% rename from docs/source/openmw-cs/index.rst rename to docs/source/manuals/openmw-cs/index.rst index dcd28081a..c9f682f17 100644 --- a/docs/source/openmw-cs/index.rst +++ b/docs/source/manuals/openmw-cs/index.rst @@ -1,5 +1,4 @@ -##################### -OpenMW CS user manual +OpenMW CS User Manual ##################### The following document is the complete user manual for *OpenMW CS*, the @@ -9,17 +8,17 @@ modding *The Elder Scrolls III: Morrowind* you should at least read the first few chapters to familiarise yourself with the new interface. .. warning:: - OpenMW CS is still software in development. The manual does not cover any of - its shortcomings, it is written as if everything was working as inteded. - Please report any software problems as bugs in the software, not errors in - the manual. + OpenMW CS is still software in development. The manual does not cover any of + its shortcomings, it is written as if everything was working as inteded. + Please report any software problems as bugs in the software, not errors in + the manual. .. toctree:: - :caption: Table of Contents - :maxdepth: 2 + :caption: Table of Contents + :maxdepth: 2 - foreword - tour - files-and-directories - starting-dialog + foreword + tour + files-and-directories + starting-dialog diff --git a/docs/source/openmw-cs/starting-dialog.rst b/docs/source/manuals/openmw-cs/starting-dialog.rst similarity index 100% rename from docs/source/openmw-cs/starting-dialog.rst rename to docs/source/manuals/openmw-cs/starting-dialog.rst diff --git a/docs/source/openmw-cs/tour.rst b/docs/source/manuals/openmw-cs/tour.rst similarity index 100% rename from docs/source/openmw-cs/tour.rst rename to docs/source/manuals/openmw-cs/tour.rst diff --git a/docs/source/openmw-mods/index.rst b/docs/source/openmw-mods/index.rst deleted file mode 100644 index 0219c037e..000000000 --- a/docs/source/openmw-mods/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -######################## -OpenMW Modding Reference -######################## - -The following document is the complete reference guide to modifying, or modding, your OpenMW setup. It does not cover content creation itself, only how to alter or add to your OpenMW gameplay experience. To learn more about creating new content for OpenMW, please refer to :doc:`../openmw-cs/index`. - -.. warning:: - OpenMW is still software in development. This manual does not cover any of its shortcomings. It is written as if everything was working as inteded. Please report any software problems as bugs in the software, not errors in the manual. - -.. toctree:: - :caption: Table of Contents - :maxdepth: 2 - - foreword - differences - mod-install - settings/index - fonts - convert_bump_mapped_mods - paths \ No newline at end of file diff --git a/docs/source/openmw/index.rst b/docs/source/openmw/index.rst deleted file mode 100644 index ce4e42f1f..000000000 --- a/docs/source/openmw/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -########################### -OpenMW Source Documentation -########################### - -.. toctree:: - :maxdepth: 2 - - mwbase - -.. autodoxygenfile:: engine.hpp - :project: openmw - -Indices and tables -================== - -* :ref:`genindex` - * :ref:`search` \ No newline at end of file diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst new file mode 100644 index 000000000..500936059 --- /dev/null +++ b/docs/source/reference/index.rst @@ -0,0 +1,7 @@ +Reference Material +================== + +.. toctree:: + :maxdepth: 2 + + modding/index \ No newline at end of file diff --git a/docs/source/openmw-mods/convert_bump_mapped_mods.rst b/docs/source/reference/modding/convert_bump_mapped_mods.rst similarity index 100% rename from docs/source/openmw-mods/convert_bump_mapped_mods.rst rename to docs/source/reference/modding/convert_bump_mapped_mods.rst diff --git a/docs/source/openmw-mods/differences.rst b/docs/source/reference/modding/differences.rst similarity index 100% rename from docs/source/openmw-mods/differences.rst rename to docs/source/reference/modding/differences.rst diff --git a/docs/source/openmw-mods/font.rst b/docs/source/reference/modding/font.rst similarity index 100% rename from docs/source/openmw-mods/font.rst rename to docs/source/reference/modding/font.rst diff --git a/docs/source/openmw-mods/foreword.rst b/docs/source/reference/modding/foreword.rst similarity index 100% rename from docs/source/openmw-mods/foreword.rst rename to docs/source/reference/modding/foreword.rst diff --git a/docs/source/reference/modding/index.rst b/docs/source/reference/modding/index.rst new file mode 100644 index 000000000..d2dd90850 --- /dev/null +++ b/docs/source/reference/modding/index.rst @@ -0,0 +1,26 @@ +OpenMW Modding Reference +######################## + +The following document is the complete reference guide to modifying, or +modding, your OpenMW setup. It does not cover content creation itself, +only how to alter or add to your OpenMW gameplay experience. To learn more +about creating new content for OpenMW, please refer to +:doc:`/manuals/openmw-cs/index`. + +.. warning:: + OpenMW is still software in development. This manual does not cover any + of its shortcomings. It is written as if everything was working as + intended. Please report any software problems as bugs in the software, + not errors in the manual. + +.. toctree:: + :caption: Table of Contents + :maxdepth: 2 + + foreword + differences + mod-install + settings/index + font + convert_bump_mapped_mods + paths diff --git a/docs/source/openmw-mods/mod-install.rst b/docs/source/reference/modding/mod-install.rst similarity index 100% rename from docs/source/openmw-mods/mod-install.rst rename to docs/source/reference/modding/mod-install.rst diff --git a/docs/source/openmw-mods/paths.rst b/docs/source/reference/modding/paths.rst similarity index 100% rename from docs/source/openmw-mods/paths.rst rename to docs/source/reference/modding/paths.rst diff --git a/docs/source/openmw-mods/settings/GUI.rst b/docs/source/reference/modding/settings/GUI.rst similarity index 100% rename from docs/source/openmw-mods/settings/GUI.rst rename to docs/source/reference/modding/settings/GUI.rst diff --git a/docs/source/openmw-mods/settings/HUD.rst b/docs/source/reference/modding/settings/HUD.rst similarity index 100% rename from docs/source/openmw-mods/settings/HUD.rst rename to docs/source/reference/modding/settings/HUD.rst diff --git a/docs/source/openmw-mods/settings/camera.rst b/docs/source/reference/modding/settings/camera.rst similarity index 99% rename from docs/source/openmw-mods/settings/camera.rst rename to docs/source/reference/modding/settings/camera.rst index 4fe3aa977..c9b69add6 100644 --- a/docs/source/openmw-mods/settings/camera.rst +++ b/docs/source/reference/modding/settings/camera.rst @@ -24,7 +24,7 @@ This setting determines whether objects that render to a few pixels or smaller w The default value is true. This setting can only be configured by editing the settings configuration file. small feature culling pixel size ---------------------- +-------------------------------- :Type: floating point :Range: > 0 diff --git a/docs/source/openmw-mods/settings/cells.rst b/docs/source/reference/modding/settings/cells.rst similarity index 100% rename from docs/source/openmw-mods/settings/cells.rst rename to docs/source/reference/modding/settings/cells.rst diff --git a/docs/source/openmw-mods/settings/game.rst b/docs/source/reference/modding/settings/game.rst similarity index 100% rename from docs/source/openmw-mods/settings/game.rst rename to docs/source/reference/modding/settings/game.rst diff --git a/docs/source/openmw-mods/settings/general.rst b/docs/source/reference/modding/settings/general.rst similarity index 100% rename from docs/source/openmw-mods/settings/general.rst rename to docs/source/reference/modding/settings/general.rst diff --git a/docs/source/openmw-mods/settings/index.rst b/docs/source/reference/modding/settings/index.rst similarity index 100% rename from docs/source/openmw-mods/settings/index.rst rename to docs/source/reference/modding/settings/index.rst diff --git a/docs/source/openmw-mods/settings/input.rst b/docs/source/reference/modding/settings/input.rst similarity index 100% rename from docs/source/openmw-mods/settings/input.rst rename to docs/source/reference/modding/settings/input.rst diff --git a/docs/source/openmw-mods/settings/map.rst b/docs/source/reference/modding/settings/map.rst similarity index 100% rename from docs/source/openmw-mods/settings/map.rst rename to docs/source/reference/modding/settings/map.rst diff --git a/docs/source/openmw-mods/settings/saves.rst b/docs/source/reference/modding/settings/saves.rst similarity index 100% rename from docs/source/openmw-mods/settings/saves.rst rename to docs/source/reference/modding/settings/saves.rst diff --git a/docs/source/openmw-mods/settings/sound.rst b/docs/source/reference/modding/settings/sound.rst similarity index 100% rename from docs/source/openmw-mods/settings/sound.rst rename to docs/source/reference/modding/settings/sound.rst diff --git a/docs/source/openmw-mods/settings/video.rst b/docs/source/reference/modding/settings/video.rst similarity index 100% rename from docs/source/openmw-mods/settings/video.rst rename to docs/source/reference/modding/settings/video.rst diff --git a/docs/source/openmw-mods/settings/water.rst b/docs/source/reference/modding/settings/water.rst similarity index 99% rename from docs/source/openmw-mods/settings/water.rst rename to docs/source/reference/modding/settings/water.rst index a5fa27972..b2d04a416 100644 --- a/docs/source/openmw-mods/settings/water.rst +++ b/docs/source/reference/modding/settings/water.rst @@ -1,5 +1,5 @@ Water Settings -############ +############## .. note:: The settings for the water shader are difficult to describe, but can be seen immediately in the Water tab of the Video panel in the Options menu. Changes there will be saved to these settings. It is suggested to stand on the shore of a moderately broad body of water with trees or other objects on the far shore to test reflection textures, underwater plants in shallow water near by to test refraction textures, and some deep water visible from your location to test deep water visibility. diff --git a/docs/source/openmw-mods/settings/windows.rst b/docs/source/reference/modding/settings/windows.rst similarity index 99% rename from docs/source/openmw-mods/settings/windows.rst rename to docs/source/reference/modding/settings/windows.rst index 9472b9a81..8860de983 100644 --- a/docs/source/openmw-mods/settings/windows.rst +++ b/docs/source/reference/modding/settings/windows.rst @@ -1,5 +1,5 @@ Windows Settings -############ +################ :Type: floating point :Range: 0.0 to 1.0 diff --git a/docs/source/source/index.rst b/docs/source/source/index.rst new file mode 100644 index 000000000..36ac318fd --- /dev/null +++ b/docs/source/source/index.rst @@ -0,0 +1,7 @@ +Project Source Documentation +============================ + +.. toctree:: + :maxdepth: 2 + + openmw/index \ No newline at end of file diff --git a/docs/source/source/openmw/index.rst b/docs/source/source/openmw/index.rst new file mode 100644 index 000000000..5367995de --- /dev/null +++ b/docs/source/source/openmw/index.rst @@ -0,0 +1,24 @@ +OpenMW Source Documentation +########################### + +.. toctree:: + :maxdepth: 2 + + mwbase + 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/openmw/mwbase.rst b/docs/source/source/openmw/mwbase.rst similarity index 98% rename from docs/source/openmw/mwbase.rst rename to docs/source/source/openmw/mwbase.rst index 182ed66f6..8fd7ffc1e 100644 --- a/docs/source/openmw/mwbase.rst +++ b/docs/source/source/openmw/mwbase.rst @@ -1,4 +1,3 @@ -######## ./mwbase ######## @@ -31,4 +30,3 @@ .. autodoxygenfile:: mwbase/world.hpp :project: openmw - diff --git a/docs/source/source/openmw/mwclass.rst b/docs/source/source/openmw/mwclass.rst new file mode 100644 index 000000000..3365d2582 --- /dev/null +++ b/docs/source/source/openmw/mwclass.rst @@ -0,0 +1,68 @@ +./mwclass +######### + +.. autodoxygenfile:: mwclass/activator.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/actor.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/apparatus.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/armor.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/bodypart.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/book.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/classes.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/clothing.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/container.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/creature.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/creaturelevlist.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/ingredient.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/itemlevlist.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/light.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/lockpick.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/misc.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/npc.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/potion.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/probe.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/repair.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/static.hpp + :project: openmw + +.. autodoxygenfile:: mwclass/weapon.hpp + :project: openmw \ No newline at end of file diff --git a/docs/source/source/openmw/mwdialogue.rst b/docs/source/source/openmw/mwdialogue.rst new file mode 100644 index 000000000..1f3522f2c --- /dev/null +++ b/docs/source/source/openmw/mwdialogue.rst @@ -0,0 +1,32 @@ +./mwdialogue +############ + +.. autodoxygenfile:: mwdialogue/dialoguemanagerimp.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/filter.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/hypertextparser.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/journalentry.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/journalimp.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/keywordsearch.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/quest.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/scripttest.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/selectwrapper.hpp + :project: openmw + +.. autodoxygenfile:: mwdialogue/topic.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwgui.rst b/docs/source/source/openmw/mwgui.rst new file mode 100644 index 000000000..0e3726832 --- /dev/null +++ b/docs/source/source/openmw/mwgui.rst @@ -0,0 +1,227 @@ +./mwgui +####### + +.. autodoxygenfile:: mwgui/alchemywindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/backgroundimage.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/birth.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/bookpage.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/bookwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/charactercreation.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/class.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/companionitemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/companionwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/confirmationdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/console.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/container.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/containeritemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/controllers.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/countdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/cursor.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/debugwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/dialogue.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/draganddrop.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/enchantingdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/exposedwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/formatting.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/hud.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/inventoryitemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/inventorywindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/itemchargeview.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/itemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/itemselection.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/itemview.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/itemwidget.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/jailscreen.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/journalbooks.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/journalviewmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/journalwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/layout.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/levelupdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/loadingscreen.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/mainmenu.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/mapwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/merchantrepair.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/messagebox.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/mode.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/pickpocketitemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/quickkeysmenu.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/race.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/recharge.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/referenceinterface.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/repair.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/review.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/savegamedialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/screenfader.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/scrollwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/settingswindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/sortfilteritemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/soulgemdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellbuyingwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellcreationdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellicons.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellview.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/spellwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/statswindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/textinput.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/timeadvancer.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/tooltips.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/tradeitemmodel.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/tradewindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/trainingwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/travelwindow.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/videowidget.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/waitdialog.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/widgets.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/windowbase.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/windowmanagerimp.hpp + :project: openmw + +.. autodoxygenfile:: mwgui/windowpinnablebase.hpp + :project: openmw diff --git a/docs/source/source/openmw/mwinput.rst b/docs/source/source/openmw/mwinput.rst new file mode 100644 index 000000000..b24d8dfdb --- /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 000000000..3427b712a --- /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 000000000..6eebab4d9 --- /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 000000000..d284f6586 --- /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 000000000..8db8f40e2 --- /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 000000000..d4fcb0e6b --- /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 000000000..2618c6ff0 --- /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 000000000..21026b3e2 --- /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 +