Automatisch erzeugte Manpages.
Damit nicht jeder sphinx auf dem Rechner haben muss,
behalten wir bis auf weiteres die aus den .rst
erzeugten Manpoages auch im Repo.
Change-Id: Id556c0d11cf5f79659d8350952ce1c014d81ea44
diff --git a/doc/lfun/check_timed_key b/doc/lfun/check_timed_key
index 81baff7..58c70ab 100644
--- a/doc/lfun/check_timed_key
+++ b/doc/lfun/check_timed_key
@@ -1,34 +1,52 @@
+
check_timed_key()
+*****************
-FUNKTION:
- public int check_timed_key(string key)
-
-DEFINIERT IN:
- /std/living/life.c
-ARGUMENTE:
- string key : Eindeutiger Name
+FUNKTION
+========
-BESCHREIBUNG:
- Diese Funktion hat die Aufgabe, mittels check_and_update_timed_key()
- gespeicherte Zeitsperren zu pruefen, aber dabei nicht zu veraendern.
+ public int check_timed_key(string key)
- Es MUSS bei der eigentlichen Aktion (z.B. Heilung des Spielers) der
- Rueckgabewert von check_and_update_timed_key() beruecksichtigt werden,
- sollte dieses nicht -1 geliefert haben, MUSS <key> als gesperrt
- betrachtet werden, d.h. check_timed_key() hat nur informativen
- Charakter.
-RUeCKGABEWERT:
- 0 Die Zeitsperre <key> ist abgelaufen.
+DEFINIERT IN
+============
- >0 <key> ist noch gesperrt.
- Der Rueckgabewert ist der Zeitpunkt, ab dem <key> wieder frei ist,
+ /std/living/life.c
-SIEHE AUCH:
- check_and_update_timed_key, eat_food, drink_alcohol, drink_soft,
- heal_self, restore_spell_points, reduce_hit_point
-----------------------------------------------------------------------------
+ARGUMENTE
+=========
+
+ string key : Eindeutiger Name
+
+
+BESCHREIBUNG
+============
+
+ Diese Funktion hat die Aufgabe, mittels check_and_update_timed_key()
+ gespeicherte Zeitsperren zu pruefen, aber dabei nicht zu veraendern.
+
+ Es MUSS bei der eigentlichen Aktion (z.B. Heilung des Spielers) der
+ Rueckgabewert von check_and_update_timed_key() beruecksichtigt werden,
+ sollte dieses nicht -1 geliefert haben, MUSS <key> als gesperrt
+ betrachtet werden, d.h. check_timed_key() hat nur informativen
+ Charakter.
+
+
+RUeCKGABEWERT
+=============
+
+ 0 Die Zeitsperre <key> ist abgelaufen.
+
+ >0 <key> ist noch gesperrt.
+ Der Rueckgabewert ist der Zeitpunkt, ab dem <key> wieder frei ist,
+
+
+SIEHE AUCH
+==========
+
+ check_and_update_timed_key, eat_food, drink_alcohol, drink_soft,
+ heal_self, restore_spell_points, reduce_hit_point
+
08.01.2012, Zesstra
-