Skip to content

Commit

Permalink
Documentation: Improved Amethyst markup in command/variable docs
Browse files Browse the repository at this point in the history
Whitespace only acts as a separator in Amethyst; replaced the
now-meaningless newline escape chars with a custom macro
(cbr = console break).
  • Loading branch information
skyjake committed Mar 30, 2013
1 parent 8b69497 commit 4dffe8a
Show file tree
Hide file tree
Showing 52 changed files with 76 additions and 54 deletions.
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/after.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Execute the specified command after a delay.
}
@description{
Params: after (tics) (cmd)\nFor example, 'after 35 "echo End"'.
Params: after (tics) (cmd) @cbr For example, 'after 35 "echo End"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/bindevent.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Bind a console command to an event.
}
@description{
Params: bindevent (event-descriptor) (command)\nExamples:\n bindevent "key-M-down" @{print "M was pressed"@}\n bindevent "mouse-right-up + key-shift" @{print "RMB released while Shift down"@}
Params: bindevent (event-descriptor) (command) @cbr Examples: @cbr bindevent "key-M-down" @{print "M was pressed"@} @cbr bindevent "mouse-right-up + key-shift" @{print "RMB released while Shift down"@}
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/blc.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set color of light at cursor.
}
@description{
Params: blc (red) (green) (blue)\nFor example, 'blc 1 0.5 0.2'.
Params: blc (red) (green) (blue) @cbr For example, 'blc 1 0.5 0.2'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/conlocp.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Connect a local player.
}
@description{
Params: conlocp (playernum)\nFor example, 'conlocp 1'.
Params: conlocp (playernum) @cbr For example, 'conlocp 1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/demolump.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Write a reference lump file for a demo.
}
@description{
Params: demolump (demofile) (lumpfile)\nFor example, 'demolump demo1.dmo DEMO1'.
Params: demolump (demofile) (lumpfile) @cbr For example, 'demolump demo1.dmo DEMO1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/dir.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Print contents of directories.
}
@description{
Params: dir (dirs) ...\nFor example, 'dir data/'.\nVirtual files are listed, too.\nPaths are relative to the base path.
Params: dir (dirs) ... @cbr For example, 'dir data/'. @cbr Virtual files are listed, too. @cbr Paths are relative to the base path.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/dump.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Dump a data lump currently loaded in memory.
}
@description{
Params: dump (name)\nFor example, 'dump PLAYPAL'.
Params: dump (name) @cbr For example, 'dump PLAYPAL'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/dumpkeymap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Write the current keymap to a file.
}
@description{
Params: dumpkeymap (file)\nFor example, 'dumpkeymap finnish.dkm'.
Params: dumpkeymap (file) @cbr For example, 'dumpkeymap finnish.dkm'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/echo.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Echo the parameters on separate lines.
}
@description{
Params: echo (cmd) ...\nFor example, 'echo "hello world"'.
Params: echo (cmd) ... @cbr For example, 'echo "hello world"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/exec.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Loads and executes a file containing console commands.
}
@description{
Params: exec (file) ...\nFor example, 'exec "myconfig.cfg"'.
Params: exec (file) ... @cbr For example, 'exec "myconfig.cfg"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/inspectmaterial.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Print extended information about a Material to the console.
}
@description{
Params: inspectmaterial (uri)\nFor example, 'inspectmaterial flats:fwater1'.
Params: inspectmaterial (uri) @cbr For example, 'inspectmaterial flats:fwater1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/inspecttexture.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Print extended information about a Texture to the console.
}
@description{
Params: inspecttexture (uri)\nFor example, 'inspecttexture flats:fwater1'.
Params: inspecttexture (uri) @cbr For example, 'inspecttexture flats:fwater1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/keymap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Load a DKM keymap file.
}
@description{
Params: keymap (dkm-file)\nFor example, 'keymap finnish'.
Params: keymap (dkm-file) @cbr For example, 'keymap finnish'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/kick.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Kick client out of the game (server only).
}
@description{
Params: kick (playernum)\nFor example, 'kick 1'.
Params: kick (playernum) @cbr For example, 'kick 1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/load.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Load a complete game or one or more data files (e.g., a WAD or a lump).
}
@description{
Params: load (name) ...\nFor example, 'load (gamename)' or 'load mylevel.wad'.
Params: load (name) ... @cbr For example, 'load (gamename)' or 'load mylevel.wad'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/ls.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Print contents of directories.
}
@description{
Params: ls (dirs) ...\nFor example, 'ls data/'.\nVirtual files are listed, too.\nPaths are relative to the base path.
Params: ls (dirs) ... @cbr For example, 'ls data/'. @cbr Virtual files are listed, too. @cbr Paths are relative to the base path.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/mipmap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set the mipmapping mode.
}
@description{
Params: mipmap (0-5)\n0 = GL_NEAREST\n1 = GL_LINEAR\n2 = GL_NEAREST_MIPMAP_NEAREST\n3 = GL_LINEAR_MIPMAP_NEAREST\n4 = GL_NEAREST_MIPMAP_LINEAR\n5 = GL_LINEAR_MIPMAP_LINEAR
Params: mipmap (0-5) @cbr 0 = GL_NEAREST @cbr 1 = GL_LINEAR @cbr 2 = GL_NEAREST_MIPMAP_NEAREST @cbr 3 = GL_LINEAR_MIPMAP_NEAREST @cbr 4 = GL_NEAREST_MIPMAP_LINEAR @cbr 5 = GL_LINEAR_MIPMAP_LINEAR
}
28 changes: 28 additions & 0 deletions doomsday/doc/engine/command/net.ame
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
@summary{
Network setup and control.
}

$*

4.4.3 Net info

Displays the current network settings along with some debug information.

4.4.14 Net search

If you want to connect to a server and you have configured your service provider with the necessary commands listed above, this command lists all the servers that can be found. Unless you're using the IPX service provider, there will be a slight delay before this command gives you the server list because DirectPlay has to first make the actual connection between the computers. It's best to keep repeating this command until you see the server you want.

4.4.15 Net connect (server number)

Connects to the specified server. Only works after "net search" shows the number of the server (usually zero).

4.4.16 Net servers

Connects to the master server and retrieves a list of running servers. You must set the console variable "net-master-address" before you can use this command. "net-master-port" should be zero, or a port of your choice (not 10123) if you're behind a firewall.

4.4.17 Net mconnect (server number received from master)

This command connects to the specified server. Only works after "net servers" has successfully ended and the list of servers has been printed in the console.

4.4.19 Net disconnect

Disconnects from the server you're currently connected to. Automatically done when you return to the operating system. You will naturally have to disconnect from a server if you want to connect to another one.

*$
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/playdemo.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Play a demo.
}
@description{
Params: playdemo (fileName)\nFor example, 'playdemo demo1.dmo'.
Params: playdemo (fileName) @cbr For example, 'playdemo demo1.dmo'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/repeat.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Repeat a command at given intervals.
}
@description{
Params: repeat (count) (interval) (cmd)\nFor example, 'repeat 10 35 "screenshot"'.
Params: repeat (count) (interval) (cmd) @cbr For example, 'repeat 10 35 "screenshot"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/setbpp.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Change color depth (bits per pixel), either 16 or 32.
}
@description{
Params: setbpp (bits)\nFor example, 'setbpp 32'.
Params: setbpp (bits) @cbr For example, 'setbpp 32'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/setcon.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set console and viewplayer.
}
@description{
Params: setcon (playernum)\nFor example, 'setcon 1'.
Params: setcon (playernum) @cbr For example, 'setcon 1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/setname.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set your name.
}
@description{
Params: setname (name)\nFor example, 'setname "my name"'.
Params: setname (name) @cbr For example, 'setname "my name"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/setres.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Change video mode resolution or window size.
}
@description{
Params: setres (width) (height)\nFor example, 'setres 1024 768'.
Params: setres (width) (height) @cbr For example, 'setres 1024 768'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/settics.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set number of game tics per second (default: 35).
}
@description{
Params: settics (tics)\nFor example, 'settics 15'.
Params: settics (tics) @cbr For example, 'settics 15'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/toggle.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Toggle the value of a cvar between zero and nonzero.
}
@description{
Params: toggle (cvar)\nFor example, 'toggle rend-light'.
Params: toggle (cvar) @cbr For example, 'toggle rend-light'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/uicolor.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Change Doomsday user interface colors.
}
@description{
Params: uicolor (object) (red) (green) (blue)\nFor example, 'uicolor text 1 1 1'.\nPossible objects are:\n text, shadow, bglight, bgmed, bgdark,\n borhigh, bormed, borlow, help
Params: uicolor (object) (red) (green) (blue) @cbr For example, 'uicolor text 1 1 1'. @cbr Possible objects are: @cbr text, shadow, bglight, bgmed, bgdark, @cbr borhigh, bormed, borlow, help
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/unload.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Unload the current game or one or more data files.
}
@description{
Params: unload (name) ...\nFor example, 'unload mylevel.wad'.
Params: unload (name) ... @cbr For example, 'unload mylevel.wad'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/engine/command/write.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Write bindings and aliases to a file.
}
@description{
Params: write (filename)\nFor example, 'write myconfig.cfg'.
Params: write (filename) @cbr For example, 'write myconfig.cfg'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/deletegamesave.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Deletes a game-save state.
}
@description{
Params: deletegamesave (game-save-name|<keyword>|save-slot-num) (confirm)\nKeywords: last, quick\nExamples:\nA game save by name 'deletegamesave "running low on ammo"'\nLast game save in the "quick" slot, confirmed: 'deletegamesave quick confirm'
Params: deletegamesave (game-save-name|<keyword>|save-slot-num) (confirm) @cbr Keywords: last, quick @cbr Examples: @cbr A game save by name 'deletegamesave "running low on ammo"' @cbr Last game save in the "quick" slot, confirmed: 'deletegamesave quick confirm'
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/loadgame.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Load a game-save or open the load menu.
}
@description{
Params: loadgame (game-save-name|<keyword>|save-slot-num) (confirm)\nKeywords: last, quick\nExamples:\nOpen load menu: 'loadgame'\nLoading named game: 'loadgame "running low on ammo"'\nLoading current "quick" slot, confirmed: 'loadgame quick confirm'\nLoading slot #0: 'loadgame 0'
Params: loadgame (game-save-name|<keyword>|save-slot-num) (confirm) @cbr Keywords: last, quick @cbr Examples: @cbr Open load menu: 'loadgame' @cbr Loading named game: 'loadgame "running low on ammo"' @cbr Loading current "quick" slot, confirmed: 'loadgame quick confirm' @cbr Loading slot #0: 'loadgame 0'
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/makecam.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Toggle camera mode.
}
@description{
Params: makecam (playernum)\nFor example, 'makecam 1'.
Params: makecam (playernum) @cbr For example, 'makecam 1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/makelocp.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Make local player.
}
@description{
Params: makelocp (playernum)\nFor example, 'makelocp 1'.
Params: makelocp (playernum) @cbr For example, 'makelocp 1'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/message.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Show a local game message.
}
@description{
Params: message (msg)\nFor example, 'message "this is a message"'.
Params: message (msg) @cbr For example, 'message "this is a message"'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/reveal.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Map cheat.
}
@description{
Params: reveal (0-4)\nModes:\n 0=nothing\n 1=show unseen\n 2=full map\n 3=map+things
Params: reveal (0-4) @cbr Modes: @cbr 0=nothing @cbr 1=show unseen @cbr 2=full map @cbr 3=map+things
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/savegame.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Create a new game-save or open the save menu.
}
@description{
Params: savegame (game-save-name|<keyword>|save-slot-num) (new game-save-name) (confirm)\nKeywords: last, quick\nExamples:\nOpen save menu: 'savegame'\nSaving to current "quick" slot: 'savegame quick "running low on ammo"'\nSaving to slot #0: 'savegame 0 "running low on ammo"'
Params: savegame (game-save-name|<keyword>|save-slot-num) (new game-save-name) (confirm) @cbr Keywords: last, quick @cbr Examples: @cbr Open save menu: 'savegame' @cbr Saving to current "quick" slot: 'savegame quick "running low on ammo"' @cbr Saving to slot #0: 'savegame 0 "running low on ammo"'
}
File renamed without changes.
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/setcolor.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set player color.
}
@description{
Params: setcolor (playernum)\nFor example, 'setcolor 4'.
Params: setcolor (playernum) @cbr For example, 'setcolor 4'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libcommon/command/startinf.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Start an InFine script.
}
@description{
Params: startinf (script-id)\nFor example, 'startinf coolscript'.
Params: startinf (script-id) @cbr For example, 'startinf coolscript'.
}
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
@summary{
Number of 35 Hz tics to pause the game after a map has been loaded.\n-1=Use the value of 'con-transition-tics'.
Number of 35 Hz tics to pause the game after a map has been loaded. @cbr -1=Use the value of 'con-transition-tics'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libdoom/command/cheat.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Issue a cheat code using the original DOOM cheats.
}
@description{
Params: cheat (cheat)\nFor example, 'cheat idclev25'.
Params: cheat (cheat) @cbr For example, 'cheat idclev25'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libdoom/command/setmap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set map.
}
@description{
Params: setmap (episode) (map)\nFor example, 'setmap 1 7'.
Params: setmap (episode) (map) @cbr For example, 'setmap 1 7'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libheretic/command/cheat.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Issue a cheat code using the original Heretic cheats.
}
@description{
Params: cheat (cheat)\nFor example, 'cheat rambo'.
Params: cheat (cheat) @cbr For example, 'cheat rambo'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libheretic/command/god.ame
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
@summary{
I don't think He needs any help...
Toggle God mode (invulnerability).
}
3 changes: 0 additions & 3 deletions doomsday/doc/libheretic/command/screenshot.ame

This file was deleted.

2 changes: 1 addition & 1 deletion doomsday/doc/libheretic/command/setmap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set map.
}
@description{
Params: setmap (episode) (map)\nFor example, 'setmap 1 7'.
Params: setmap (episode) (map) @cbr For example, 'setmap 1 7'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libhexen/command/cheat.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Issue a cheat code using the original Hexen cheats.
}
@description{
Params: cheat (cheat)\nFor example, 'cheat satan'.
Params: cheat (cheat) @cbr For example, 'cheat satan'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libhexen/command/god.ame
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
@summary{
I don't think He needs any help...
Toggle God mode (invulnerability).
}
2 changes: 1 addition & 1 deletion doomsday/doc/libhexen/command/runscript.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Run an ACS script.
}
@description{
Params: runscript (1-99)\n.
Params: runscript (1-99).
}
3 changes: 0 additions & 3 deletions doomsday/doc/libhexen/command/screenshot.ame

This file was deleted.

2 changes: 1 addition & 1 deletion doomsday/doc/libhexen/command/setmap.ame
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
Set map.
}
@description{
Params: setmap (map)\nFor example, 'setmap 23'.
Params: setmap (map) @cbr For example, 'setmap 23'.
}
2 changes: 1 addition & 1 deletion doomsday/doc/libhexen/variable/player-color.ame
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
@summary{
Player color: 0=blue, 1=red, 2=yellow, 3=green, 4=jade, 5=white,\n6=hazel, 7=purple, 8=auto.
Player color: 0=blue, 1=red, 2=yellow, 3=green, 4=jade, 5=white, @cbr 6=hazel, 7=purple, 8=auto.
}

0 comments on commit 4dffe8a

Please sign in to comment.