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/props/P_SHORT b/doc/props/P_SHORT
index b6502d4..49b2603 100644
--- a/doc/props/P_SHORT
+++ b/doc/props/P_SHORT
@@ -1,41 +1,60 @@
+
P_SHORT
-NAME:
- P_SHORT "short"
+*******
-DEFINIERT IN:
- /sys/thing/description.h
-BESCHREIBUNG:
- Diese Property enthaelt die Kurzbeschreibung des Objektes als String
- oder Closure (diese muss einen String zurueckgeben).
+NAME
+====
- ACHTUNG: Die Kurzbeschreibung sollte dabei weder mit einem
- Satzzeichen noch mit einem "\n" abgeschlossen sein
- (dies wird von den zustaendigen Funktionen erledigt).
+ P_SHORT "short"
- Setzt man diese Property auf 0, so ist das Objekt unsichtbar, allerdings
- ansprechbar, wenn der Spieler eine ID des Objektes kennt. D.h. Objekte
- koennen mitgenommen, weggeworfen oder ggf. auch angegriffen werden. Will
- man dies nicht, sollte man das Objekt mit P_INVIS unsichtbar machen.
- Diese Property bestimmt die Ansicht des Objektes von aussen. Fuer die
- Innen(kurz)ansicht von Raeumen muss man P_INT_LONG benutzen.
+DEFINIERT IN
+============
-BEMERKUNGEN:
- Die Funktion, die die Kurzbeschreibung ausgibt (short()), filtert P_SHORT
- durch process_string(). Von der Nutzung dieses Features wird in neuem
- Code abgeraten.
- Soll eine dyn. Kurzbeschreibung geschaffen werden, bitte eine
- F_QUERY_METHOD einsetzen oder short() passend ueberschreiben.
+ /sys/thing/description.h
-BEISPIELE:
- // eine Axt sieht natuerlich so aus:
- SetProp(P_SHORT, "Eine Axt");
-SIEHE AUCH:
- Aehnliches: P_LONG, short()
- Sonstiges: P_INT_SHORT, process_string()
+BESCHREIBUNG
+============
-----------------------------------------------------------------------------
+ Diese Property enthaelt die Kurzbeschreibung des Objektes als String
+ oder Closure (diese muss einen String zurueckgeben).
+
+ ACHTUNG: Die Kurzbeschreibung sollte dabei weder mit einem
+ Satzzeichen noch mit einem "\n" abgeschlossen sein
+ (dies wird von den zustaendigen Funktionen erledigt).
+
+ Setzt man diese Property auf 0, so ist das Objekt unsichtbar, allerdings
+ ansprechbar, wenn der Spieler eine ID des Objektes kennt. D.h. Objekte
+ koennen mitgenommen, weggeworfen oder ggf. auch angegriffen werden. Will
+ man dies nicht, sollte man das Objekt mit P_INVIS unsichtbar machen.
+
+ Diese Property bestimmt die Ansicht des Objektes von aussen. Fuer die
+ Innen(kurz)ansicht von Raeumen muss man P_INT_LONG benutzen.
+
+
+BEMERKUNGEN
+===========
+
+ Die Funktion, die die Kurzbeschreibung ausgibt (short()), filtert P_SHORT
+ durch process_string(). Von der Nutzung dieses Features wird in neuem
+ Code abgeraten.
+ Soll eine dyn. Kurzbeschreibung geschaffen werden, bitte eine
+ F_QUERY_METHOD einsetzen oder short() passend ueberschreiben.
+
+
+BEISPIELE
+=========
+
+ // eine Axt sieht natuerlich so aus:
+ SetProp(P_SHORT, "Eine Axt");
+
+
+SIEHE AUCH
+==========
+
+ Aehnliches: P_LONG, short()
+ Sonstiges: P_INT_SHORT, process_string()
+
27.05.2015, Zesstra
-