Commit Graph

6 Commits

Author SHA1 Message Date
0cae214a78 == python api docs ==
bge.types
---------

- removed lists if they were already available in bge.logic and crosslinked
  where the list contained description, moved the descriptions in bge.logic
  so we have useful thing in one place only
- fixed a lot of bad formatting, like bad indentation and usage of TAB
- changed from literal to codeblocks that smerch for the useful suggestion :)
- whered appropriate I've moved code examples to the end, after notes and all
  it is blocking to have a big black block before actually see a method parameters or return type
- have doubt about the list at bge.types.html#bge.types.SCA_MouseSensor.mode
  possibly tomorrow will ask Dalai
  
bge.logic
---------

- added sensor status list
- cross linked with bge.types where needed
- added a section "ShapeAction Actuator" because in bge.types these constants are docuemented, but in 2.5 I don't see the ShapeAction Actuator 
(anymore, or for now)
  I'll ask Dalai tomorrow or when possible (check bge.logic.html#shape-action-actuator once cambo rebuilds the docs)
- moved descriptions from bge.types lists to logic page where appropriate
- where possible, added custom directive :value: so we have a consistent way to show the value of constants
2010-06-07 23:50:43 +00:00
2beef23a9b == python api docs ==
some more cleanup:

  - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly
  - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags
  - substituted some lists of possible values of a parameter with links to lists of values (not finished)
    like in bge.types.html#bge.types.SCA_PythonKeyboard
  - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status 
    (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
8ad29c02e0 == bge api docs ==
- fixed small typo in bge.events.rst
- also testing committing to bf-blender, my first commit :)
2010-05-30 18:18:14 +00:00
6b918fb86f = Game Engine PyDocs =
Document's headers trailing dots removed, to make them consistent with other docs.
2010-05-28 19:59:15 +00:00
45444ceee3 include game engine docs in sphinx doc generation:
bge.events, logic, render & types (others still need work)

Updated http://www.blender.org/documentation/250PythonDoc
2010-05-17 20:38:54 +00:00
3a12668e92 epydoc to sphinx markup for GameLogic module 2010-05-17 19:52:25 +00:00