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/UnregisterHelperObject b/doc/lfun/UnregisterHelperObject
index eefd84e..d6242c9 100644
--- a/doc/lfun/UnregisterHelperObject
+++ b/doc/lfun/UnregisterHelperObject
@@ -1,47 +1,71 @@
-FUNKTION:
- int UnregisterHelperObject(object helper, int type);
-DEFINIERT IN:
- /std/living/helpers.c
+UnregisterHelperObject()
+************************
-ARGUMENTE:
- object helper
- Das Objekt, das als Hilfsobjekt deregistriert werden soll.
- int type
- Helfertyp, einer der in /sys/living/helpers.h definierten Typen:
- - HELPER_TYPE_AERIAL fuer die Flug-/Segelunterstuetzung
- - HELPER_TYPE_AQUATIC fuer Tauchunterstuetzung
-BESCHREIBUNG:
- Das als Hilfsobjekt fuer bestimmte Aktivitaeten wie zum Beispiel Tauchen
- oder Fliegen bei einem Lebewesen registrierte Objekt "helper" meldet
- sich bei diesem ab.
- Hinweis: fuer eine temporaer gueltige "Nicht-Zustaendigkeit" kaeme auch
- in Frage, in dieser Zeit einfach "0" zurueckzugeben, statt sich
- komplett abzumelden.
+FUNKTION
+========
-RUECKGABEWERTE:
- 1 Objekt wurde erfolgreich ausgetragen (HELPER_SUCCESS)
- -1 angegebenes Hilfsobjekt existiert nicht (HELPER_NO_CALLBACK_OBJECT)
- -3 angegebenes Hilfsobjekt war gar nicht angemeldet
- (HELPER_NOTHING_TO_UNREGISTER)
+ int UnregisterHelperObject(object helper, int type);
-BEISPIEL:
- Eine luftgefuellte Blase hatte sich als Tauch-Helfer am Spieler
- angemeldet, ist jetzt aber verbraucht und meldet sich daher ab:
- // Austragen im Spielerobjekt
- void BlaseAustragen() {
- [...]
- if ( TP->UnregisterHelperObject(ME, HELPER_TYPE_AQUATIC)
- == HELPER_SUCCESS )
- remove();
- }
+DEFINIERT IN
+============
-SIEHE AUCH:
- Funktionen: RegisterHelperObject()
- Properties: P_HELPER_OBJECTS, P_AERIAL_HELPERS, P_AQUATIC_HELPERS
- Sonstiges: /sys/living/helpers.h
+ /std/living/helpers.c
+
+
+ARGUMENTE
+=========
+
+ object helper
+ Das Objekt, das als Hilfsobjekt deregistriert werden soll.
+ int type
+ Helfertyp, einer der in /sys/living/helpers.h definierten Typen:
+ - HELPER_TYPE_AERIAL fuer die Flug-/Segelunterstuetzung
+ - HELPER_TYPE_AQUATIC fuer Tauchunterstuetzung
+
+
+BESCHREIBUNG
+============
+
+ Das als Hilfsobjekt fuer bestimmte Aktivitaeten wie zum Beispiel Tauchen
+ oder Fliegen bei einem Lebewesen registrierte Objekt "helper" meldet
+ sich bei diesem ab.
+ Hinweis: fuer eine temporaer gueltige "Nicht-Zustaendigkeit" kaeme auch
+ in Frage, in dieser Zeit einfach "0" zurueckzugeben, statt sich
+ komplett abzumelden.
+
+
+RUECKGABEWERTE
+==============
+
+ 1 Objekt wurde erfolgreich ausgetragen (HELPER_SUCCESS)
+ -1 angegebenes Hilfsobjekt existiert nicht (HELPER_NO_CALLBACK_OBJECT)
+ -3 angegebenes Hilfsobjekt war gar nicht angemeldet
+ (HELPER_NOTHING_TO_UNREGISTER)
+
+
+BEISPIEL
+========
+
+ Eine luftgefuellte Blase hatte sich als Tauch-Helfer am Spieler
+ angemeldet, ist jetzt aber verbraucht und meldet sich daher ab:
+
+ // Austragen im Spielerobjekt
+ void BlaseAustragen() {
+ [...]
+ if ( TP->UnregisterHelperObject(ME, HELPER_TYPE_AQUATIC)
+ == HELPER_SUCCESS )
+ remove();
+ }
+
+
+SIEHE AUCH
+==========
+
+ Funktionen: RegisterHelperObject()
+ Properties: P_HELPER_OBJECTS, P_AERIAL_HELPERS, P_AQUATIC_HELPERS
+ Sonstiges: /sys/living/helpers.h
19.02.2013 Arathorn
-