Skip to content

Commit

Permalink
Documentation: Trying out Amethyst formatting in selected commands
Browse files Browse the repository at this point in the history
  • Loading branch information
skyjake committed Apr 1, 2013
1 parent 88b7b08 commit be4d802
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doomsday/doc/engine/command/echo.ame
Expand Up @@ -2,5 +2,6 @@
Echo the parameters on separate lines.
}
@description{
Params: echo (cmd) ... @cbr For example, 'echo "hello world"'.
@params{echo (text) ...} @cbr
@example{@cmd{echo "hello world"}}
}
3 changes: 2 additions & 1 deletion doomsday/doc/engine/command/load.ame
Expand Up @@ -2,5 +2,6 @@
Load a complete game or one or more data files (e.g., a WAD or a lump).
}
@description{
Params: load (name) ... @cbr For example, 'load (gamename)' or 'load mylevel.wad'.
@params{load (name) ...} @cbr
@example{@cmd{load (gamename)} or @cmd{load mylevel.wad}}
}
3 changes: 2 additions & 1 deletion doomsday/doc/libcommon/command/message.ame
Expand Up @@ -2,5 +2,6 @@
Show a local game message.
}
@description{
Params: message (msg) @cbr For example, 'message "this is a message"'.
@params{message (text)} @cbr
@example{@cmd{message "this is a message"}}
}
21 changes: 21 additions & 0 deletions doomsday/doc/libhexen/command/give.ame
@@ -1,3 +1,24 @@
@summary{
Cheat command to give you various kinds of things.
}
@description{
@params{
give (stuff) @cbr
(stuff) consists of one or more of (type:id).
If no id, all is given:
@deflist{
@item{a} ammo
@item{h} health
@item{i} items
@item{k} keys
@item{p} puzzle
@item{r} armor
@item{w} weapons
}
}
@cbr
@example{
@cmd{give ikw} gives items, keys and weapons. @cbr
@cmd{give w2k1} gives weapon two and key one.
}
}

0 comments on commit be4d802

Please sign in to comment.