浏览代码

Changed bbdoc tables to markdown format.

woollybah 6 年之前
父节点
当前提交
d227605c76
共有 5 个文件被更改,包括 176 次插入171 次删除
  1. 30 29
      event.mod/doc/intro.bbdoc
  2. 8 7
      graphics.mod/doc/intro.bbdoc
  3. 5 4
      hook.mod/doc/intro.bbdoc
  4. 123 121
      keycodes.mod/doc/intro.bbdoc
  5. 10 10
      reflection.mod/doc/intro.bbdoc

+ 30 - 29
event.mod/doc/intro.bbdoc

@@ -8,32 +8,33 @@ the #EmitEventHook hook, or by using using the global #{event queue}
 The most important field in an event object is the @id field, which identifies the kind of 
 event:
 
-[ @{Event id} | @Description
-* EVENT_APPSUSPEND | Application suspended
-* EVENT_APPRESUME | Application resumed
-* EVENT_APPTERMINATE | Application wants to terminate
-* EVENT_KEYDOWN | Key pressed. Event data contains keycode
-* EVENT_KEYUP | Key released. Event data contains keycode
-* EVENT_KEYCHAR | Key character. Event data contains unicode value
-* EVENT_MOUSEDOWN | Mouse button pressed. Event data contains mouse button code
-* EVENT_MOUSEUP | Mouse button released. Event data contains mouse button code
-* EVENT_MOUSEMOVE | Mouse moved. Event x and y contain mouse coordinates
-* EVENT_MOUSEWHEEL | Mouse wheel spun. Event data contains delta clicks
-* EVENT_MOUSEENTER | Mouse entered gadget area
-* EVENT_MOUSELEAVE | Mouse left gadget area
-* EVENT_TIMERTICK | Timer ticked. Event source contains timer object
-* EVENT_HOTKEYHIT | Hot key hit. Event data and mods contains hotkey keycode and modifier
-* EVENT_MENUACTION | Menu has been selected
-* EVENT_WINDOWMOVE | Window has been moved
-* EVENT_WINDOWSIZE | Window has been resized
-* EVENT_WINDOWCLOSE | Window close icon clicked
-* EVENT_WINDOWACTIVATE | Window activated
-* EVENT_WINDOWACCEPT | Drag and Drop operation was attempted
-* EVENT_GADGETACTION | Gadget state has been updated
-* EVENT_GADGETPAINT | A Canvas Gadget needs to be redrawn
-* EVENT_GADGETSELECT | A TreeView Node has been selected
-* EVENT_GADGETMENU | User has right clicked a TreeView Node or TextArea gadget
-* EVENT_GADGETOPEN | A TreeView Node has been expanded
-* EVENT_GADGETCLOSE | A TreeView Node has been collapsed
-* EVENT_GADGETDONE | An HTMLView has completed loading a page
-]
+| Event id | Description |
+| --- | --- |
+| EVENT_APPSUSPEND | Application suspended |
+| EVENT_APPRESUME | Application resumed |
+| EVENT_APPTERMINATE | Application wants to terminate |
+| EVENT_KEYDOWN | Key pressed. Event data contains keycode |
+| EVENT_KEYUP | Key released. Event data contains keycode |
+| EVENT_KEYCHAR | Key character. Event data contains unicode value |
+| EVENT_MOUSEDOWN | Mouse button pressed. Event data contains mouse button code |
+| EVENT_MOUSEUP | Mouse button released. Event data contains mouse button code |
+| EVENT_MOUSEMOVE | Mouse moved. Event x and y contain mouse coordinates |
+| EVENT_MOUSEWHEEL | Mouse wheel spun. Event data contains delta clicks |
+| EVENT_MOUSEENTER | Mouse entered gadget area |
+| EVENT_MOUSELEAVE | Mouse left gadget area |
+| EVENT_TIMERTICK | Timer ticked. Event source contains timer object |
+| EVENT_HOTKEYHIT | Hot key hit. Event data and mods contains hotkey keycode and modifier |
+| EVENT_MENUACTION | Menu has been selected |
+| EVENT_WINDOWMOVE | Window has been moved |
+| EVENT_WINDOWSIZE | Window has been resized |
+| EVENT_WINDOWCLOSE | Window close icon clicked |
+| EVENT_WINDOWACTIVATE | Window activated |
+| EVENT_WINDOWACCEPT | Drag and Drop operation was attempted |
+| EVENT_GADGETACTION | Gadget state has been updated |
+| EVENT_GADGETPAINT | A Canvas Gadget needs to be redrawn |
+| EVENT_GADGETSELECT | A TreeView Node has been selected |
+| EVENT_GADGETMENU | User has right clicked a TreeView Node or TextArea gadget |
+| EVENT_GADGETOPEN | A TreeView Node has been expanded |
+| EVENT_GADGETCLOSE | A TreeView Node has been collapsed |
+| EVENT_GADGETDONE | An HTMLView has completed loading a page |
+

+ 8 - 7
graphics.mod/doc/intro.bbdoc

@@ -46,13 +46,14 @@ of the available hardware's capabilities. This is achieved by using software tim
 techniques when necessary.
 
 The @flags parameter can be any combination of the following:
-[ @Flags | @Meaning
-* GRAPHICS_BACKBUFFER | Create graphics with a back buffer
-* GRAPHICS_ALPHABUFFER | Create graphics with an alpha buffer
-* GRAPHICS_DEPTHBUFFER | Create graphics with a depth buffer
-* GRAPHICS_STENCILBUFFER | Create graphics with a stencil buffer
-* GRAPHICS_ACCUMBUFFER | Create graphics with an accumulation buffer
-]
+| Flags | Meaning |
+| --- | --- |
+| GRAPHICS_BACKBUFFER | Create graphics with a back buffer |
+| GRAPHICS_ALPHABUFFER | Create graphics with an alpha buffer |
+| GRAPHICS_DEPTHBUFFER | Create graphics with a depth buffer |
+| GRAPHICS_STENCILBUFFER | Create graphics with a stencil buffer |
+| GRAPHICS_ACCUMBUFFER | Create graphics with an accumulation buffer |
+
 Flags can be combined with the | (or) operator. For example, GRAPHICS_BACKBUFFER|GRAPHICS_DEPTHBUFFER
 can be used to create graphics which has both a back buffer and a depth buffer.
 

+ 5 - 4
hook.mod/doc/intro.bbdoc

@@ -4,10 +4,11 @@ hooks into your own code.
 
 The following hook ids are currently used by BlitzMax modules:
 
-[ @{Hook id} | @Description | @Data
-* FlipHook | A Max2D #Flip is about to occur | Null
-* EmitEventHook | An event has been emitted by a call to #EmitEvent | A #TEvent object
-]
+| Hook id | Description | Data |
+| --- | --- | --- |
+| FlipHook | A Max2D #Flip is about to occur | Null |
+| EmitEventHook | An event has been emitted by a call to #EmitEvent | A #TEvent object |
+
 To hook into any of these functions, use #AddHook with the specified hook id and your hook function.
 
 To provide hook support for your own code, use #AllocHookId to generate a valid integer hook id 

+ 123 - 121
keycodes.mod/doc/intro.bbdoc

@@ -4,126 +4,128 @@ keys, modifiers and mouse buttons.
 
 These codes are used by key and mouse #events, and by the #{polled input} module.
 
-[ @{Mouse Button} | @{Value}
-* Left mouse button | MOUSE_LEFT
-* Right mouse button | MOUSE_RIGHT
-* Middle mouse button | MOUSE_MIDDLE
-]
+| Mouse Button | Value |
+| --- | --- |
+| Left mouse button | MOUSE_LEFT |
+| Right mouse button | MOUSE_RIGHT |
+| Middle mouse button | MOUSE_MIDDLE |
 
-[ @{Modifier} | @{Value}
-* Shift modifier | MODIFIER_SHIFT
-* Control modifier | MODIFIER_CONTROL
-* Option modifier | MODIFIER_OPTION
-* System modifier | MODIFIER_SYSTEM
-* Command modifier | MODIFIER_COMMAND
-]
 
-[ @{Key} | @{Value}
-* Backspace | KEY_BACKSPACE
-* Tab | KEY_TAB
-* Clear | KEY_CLEAR
-* Return | KEY_RETURN
-* Enter | KEY_ENTER
-* Pause | KEY_PAUSE
-* Escape | KEY_ESCAPE
-* Space | KEY_SPACE
-* Page Up | KEY_PAGEUP
-* Page Down | KEY_PAGEDOWN
-* End | KEY_END
-* Home | KEY_HOME
-* Cursor (Left) | KEY_LEFT
-* Cursor (Up) | KEY_UP
-* Cursor (Right) | KEY_RIGHT
-* Cursor (Down) | KEY_DOWN
-* Select | KEY_SELECT
-* Print | KEY_PRINT
-* Execute | KEY_EXECUTE
-* Screen | KEY_SCREEN
-* Insert | KEY_INSERT
-* Delete | KEY_DELETE
-* Help | KEY_HELP
-* 0 | KEY_0
-* 1 | KEY_1
-* 2 | KEY_2
-* 3 | KEY_3
-* 4 | KEY_4
-* 5 | KEY_5
-* 6 | KEY_6
-* 7 | KEY_7
-* 8 | KEY_8
-* 9 | KEY_9
-* A | KEY_A
-* B | KEY_B
-* C | KEY_C
-* D | KEY_D
-* E | KEY_E
-* F | KEY_F
-* G | KEY_G
-* H | KEY_H
-* I | KEY_I
-* J | KEY_J
-* K | KEY_K
-* L | KEY_L
-* M | KEY_M
-* N | KEY_N
-* O | KEY_O
-* P | KEY_P
-* Q | KEY_Q
-* R | KEY_R
-* S | KEY_S
-* T | KEY_T
-* U | KEY_U
-* V | KEY_V
-* W | KEY_W
-* X | KEY_X
-* Y | KEY_Y
-* Z | KEY_Z
-* Sys key (Left) | KEY_LSYS
-* Sys key (Right) | KEY_RSYS
-* Numpad 0 | KEY_NUM0
-* Numpad 1 | KEY_NUM1
-* Numpad 2 | KEY_NUM2
-* Numpad 3 | KEY_NUM3
-* Numpad 4 | KEY_NUM4
-* Numpad 5 | KEY_NUM5
-* Numpad 6 | KEY_NUM6
-* Numpad 7 | KEY_NUM7
-* Numpad 8 | KEY_NUM8
-* Numpad 9 | KEY_NUM9
-* Numpad * | KEY_NUMMULTIPLY
-* Numpad + | KEY_NUMADD
-* Numpad - | KEY_NUMSUBTRACT
-* Numpad . | KEY_NUMDECIMAL
-* Numpad / | KEY_NUMDIVIDE
-* F1 | KEY_F1
-* F2 | KEY_F2
-* F3 | KEY_F3
-* F4 | KEY_F4
-* F5 | KEY_F5
-* F6 | KEY_F6
-* F7 | KEY_F7
-* F8 | KEY_F8
-* F9 | KEY_F9
-* F10 | KEY_F10
-* F11 | KEY_F11
-* F12 | KEY_F12
-* Num Lock | KEY_NUMLOCK
-* Scroll Lock | KEY_SCROLL
-* Shift (Left) | KEY_LSHIFT
-* Shift (Right) | KEY_RSHIFT
-* Control (Left) | KEY_LCONTROL
-* Control (Right) | KEY_RCONTROL
-* Alt key (Left) | KEY_LALT
-* Alt key (Right) | KEY_RALT
-* Tilde | KEY_TILDE
-* Minus | KEY_MINUS
-* Equals | KEY_EQUALS
-* Bracket (Open) | KEY_OPENBRACKET
-* Bracket (Close) | KEY_CLOSEBRACKET
-* Backslash | KEY_BACKSLASH
-* Semi-colon | KEY_SEMICOLON
-* Quote | KEY_QUOTES
-* Comma | KEY_COMMA
-* Period | KEY_PERIOD
-* Slash | KEY_SLASH
-]
+| Modifier | Value |
+| --- | --- |
+| Shift modifier | MODIFIER_SHIFT |
+| Control modifier | MODIFIER_CONTROL |
+| Option modifier | MODIFIER_OPTION |
+| System modifier | MODIFIER_SYSTEM |
+| Command modifier | MODIFIER_COMMAND |
+
+
+| Key | Value |
+| --- | --- |
+| Backspace | KEY_BACKSPACE |
+| Tab | KEY_TAB |
+| Clear | KEY_CLEAR |
+| Return | KEY_RETURN |
+| Enter | KEY_ENTER |
+| Pause | KEY_PAUSE |
+| Escape | KEY_ESCAPE |
+| Space | KEY_SPACE |
+| Page Up | KEY_PAGEUP |
+| Page Down | KEY_PAGEDOWN |
+| End | KEY_END |
+| Home | KEY_HOME |
+| Cursor (Left) | KEY_LEFT |
+| Cursor (Up) | KEY_UP |
+| Cursor (Right) | KEY_RIGHT |
+| Cursor (Down) | KEY_DOWN |
+| Select | KEY_SELECT |
+| Print | KEY_PRINT |
+| Execute | KEY_EXECUTE |
+| Screen | KEY_SCREEN |
+| Insert | KEY_INSERT |
+| Delete | KEY_DELETE |
+| Help | KEY_HELP |
+| 0 | KEY_0 |
+| 1 | KEY_1 |
+| 2 | KEY_2 |
+| 3 | KEY_3 |
+| 4 | KEY_4 |
+| 5 | KEY_5 |
+| 6 | KEY_6 |
+| 7 | KEY_7 |
+| 8 | KEY_8 |
+| 9 | KEY_9 |
+| A | KEY_A |
+| B | KEY_B |
+| C | KEY_C |
+| D | KEY_D |
+| E | KEY_E |
+| F | KEY_F |
+| G | KEY_G |
+| H | KEY_H |
+| I | KEY_I |
+| J | KEY_J |
+| K | KEY_K |
+| L | KEY_L |
+| M | KEY_M |
+| N | KEY_N |
+| O | KEY_O |
+| P | KEY_P |
+| Q | KEY_Q |
+| R | KEY_R |
+| S | KEY_S |
+| T | KEY_T |
+| U | KEY_U |
+| V | KEY_V |
+| W | KEY_W |
+| X | KEY_X |
+| Y | KEY_Y |
+| Z | KEY_Z |
+| Sys key (Left) | KEY_LSYS |
+| Sys key (Right) | KEY_RSYS |
+| Numpad 0 | KEY_NUM0 |
+| Numpad 1 | KEY_NUM1 |
+| Numpad 2 | KEY_NUM2 |
+| Numpad 3 | KEY_NUM3 |
+| Numpad 4 | KEY_NUM4 |
+| Numpad 5 | KEY_NUM5 |
+| Numpad 6 | KEY_NUM6 |
+| Numpad 7 | KEY_NUM7 |
+| Numpad 8 | KEY_NUM8 |
+| Numpad 9 | KEY_NUM9 |
+| Numpad | | KEY_NUMMULTIPLY |
+| Numpad + | KEY_NUMADD |
+| Numpad - | KEY_NUMSUBTRACT |
+| Numpad . | KEY_NUMDECIMAL |
+| Numpad / | KEY_NUMDIVIDE |
+| F1 | KEY_F1 |
+| F2 | KEY_F2 |
+| F3 | KEY_F3 |
+| F4 | KEY_F4 |
+| F5 | KEY_F5 |
+| F6 | KEY_F6 |
+| F7 | KEY_F7 |
+| F8 | KEY_F8 |
+| F9 | KEY_F9 |
+| F10 | KEY_F10 |
+| F11 | KEY_F11 |
+| F12 | KEY_F12 |
+| Num Lock | KEY_NUMLOCK |
+| Scroll Lock | KEY_SCROLL |
+| Shift (Left) | KEY_LSHIFT |
+| Shift (Right) | KEY_RSHIFT |
+| Control (Left) | KEY_LCONTROL |
+| Control (Right) | KEY_RCONTROL |
+| Alt key (Left) | KEY_LALT |
+| Alt key (Right) | KEY_RALT |
+| Tilde | KEY_TILDE |
+| Minus | KEY_MINUS |
+| Equals | KEY_EQUALS |
+| Bracket (Open) | KEY_OPENBRACKET |
+| Bracket (Close) | KEY_CLOSEBRACKET |
+| Backslash | KEY_BACKSLASH |
+| Semi-colon | KEY_SEMICOLON |
+| Quote | KEY_QUOTES |
+| Comma | KEY_COMMA |
+| Period | KEY_PERIOD |
+| Slash | KEY_SLASH |

+ 10 - 10
reflection.mod/doc/intro.bbdoc

@@ -64,14 +64,14 @@ update.Invoke obj,[String( .25 )]
 This example uses @FindMethod to locate a type method and @Invoke to call it. Arguments to the method are contained in an object array, and again the float argument is converted to a string.
 
 In addition to the TTypeId, TField and TMethod types, the BlitzMax reflection module also declares a number of global TTypeId objects:
-[ 
-* @ByteTypeId
-* @ShortTypeId
-* @IntTypeId
-* @LongTypeId
-* @FloatTypeId
-* @DoubleTypeId
-* @StringTypeId
-* @ObjectTypeId
-]
+
+ * @ByteTypeId
+ * @ShortTypeId
+ * @IntTypeId
+ * @LongTypeId
+ * @FloatTypeId
+ * @DoubleTypeId
+ * @StringTypeId
+ * @ObjectTypeId
+
 These may be used instead of the corresponding TTypeId.ForName call. For example, @{TTypeId.ForName( "Int" )} and @IntTypeId will return the same object.