Documentation|Console: Improved docs for some commands and variables

Also added a dry run mode for wikidocs.py.

doomsday/build/scripts/wikidocs.py

@@ -1,5 +1,7 @@
 import sys, os, subprocess
 
+isDryRun = '--dry-run' in sys.argv
+
 sys.path += ['/Users/jaakko/Dropbox/Scripts']
 import dew
 
@@ -105,6 +107,10 @@ def appendCollectionToTitle(self, col):
             page.mode = mode
             pagesForCollection[col][title] = page
 
+            if isDryRun:
+                print page.title
+                print page.content
+
             # Just the summary for the index.
             templ = '@require{amestd}\n'
             templ += '@macro{summary}{@arg}\n'
@@ -155,6 +161,14 @@ def appendCollectionToTitle(self, col):
 for m in modes:
     indexPage[m] += '\n[[Category:Console]]\n[[Category:References]]\n'
 
+if isDryRun:
+    print indexPage['command']
+    print indexPage['variable']
+    for amb in ambigs:
+        print amb.title
+        print amb.content
+    sys.exit()   
+
 
 dew.login()
 

doomsday/doc/engine/command/echo.ame

@@ -3,5 +3,5 @@
 }
 @description{
     @params{echo (text) ...} @cbr 
-    @example{@cmd{echo "hello world"}}
+    @example{@code{echo "hello world"}}
 }

doomsday/doc/engine/command/load.ame

@@ -3,5 +3,5 @@
 }
 @description{
     @params{load (name) ...} @cbr
-    @example{@cmd{load (gamename)} or @cmd{load mylevel.wad}}
+    @example{@code{load (gamename)} or @code{load mylevel.wad}}
 }

doomsday/doc/libcommon/command/message.ame

@@ -3,5 +3,5 @@
 }
 @description{
     @params{message (text)} @cbr 
-    @example{@cmd{message "this is a message"}}
+    @example{@code{message "this is a message"}}
 }

doomsday/doc/libcommon/command/savegame.ame

@@ -2,5 +2,13 @@
     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) @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"'
+    @params{
+        savegame (game-save-name|<keyword>|save-slot-num) 
+                 (new game-save-name) (confirm) @cbr 
+        Keywords: last, quick } @cbr
+    @example{
+        Open save menu: @code{savegame} @cbr 
+        Saving to current "quick" slot: @code{savegame quick "running low on ammo"} @cbr 
+        Saving to slot #0: @code{savegame 0 "running low on ammo"}
+    }
 }

doomsday/doc/libcommon/command/screenshot.ame

@@ -1,3 +1,6 @@
 @summary{
-    Takes a screenshot.
+    Take a screenshot.
+}
+@description{
+    The screenshot is saved into the runtime directory.
 }

doomsday/doc/libcommon/variable/server-game-mod-gravity.ame

@@ -0,0 +1,3 @@
+@summary{
+    World gravity modifier, multiplayer (-1..100). -1=Map default.
+}

doomsday/doc/libhexen/command/give.ame

@@ -18,7 +18,7 @@
     }
     @cbr
     @example{
-        @cmd{give ikw} gives items, keys and weapons. @cbr
-        @cmd{give w2k1} gives weapon two and key one.
+        @code{give ikw} gives items, keys and weapons. @cbr
+        @code{give w2k1} gives weapon two and key one.
     }
 }