X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fctables.h;h=37ed92ce0dac923b83ee2c24f217d76b1e8a0d27;hb=0d3ecb964292600ec1ce6ee1cef83f72185a8bcc;hp=f744d63406d9f2c9de7c976bbf90be38ebb0b369;hpb=c512706209dbbf7aff9f129782b8417267808c96;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/ctables.h b/include/ctables.h
index f744d6340..37ed92ce0 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -23,6 +23,11 @@ enum CmdResult
 	CMD_INVALID = 2		/* Command doesnt exist at all! */
 };
 
+/** Translation types for translation of parameters to UIDs.
+ * This allows the core commands to not have to be aware of how UIDs
+ * work (making it still possible to write other linking modules which
+ * do not use UID (but why would you want to?)
+ */
 enum TranslateType
 {
 	TR_END,			/* End of known parameters, everything after this is TR_TEXT */
@@ -30,7 +35,7 @@ enum TranslateType
 	TR_NICK,		/* Nickname, translate to UUID for server->server */
 	TR_NICKLIST,		/* Comma seperated nickname list, translate to UUIDs */
 	TR_SPACENICKLIST,	/* Space seperated nickname list, translate to UUIDs */
-	TR_CUSTOM,		/* Custom translation handled by EncodeParameter/DecodeParameter */
+	TR_CUSTOM		/* Custom translation handled by EncodeParameter/DecodeParameter */
 };
 
 /** For commands which should not be replicated to other
@@ -81,6 +86,9 @@ class CoreExport Command : public Extensible
 	 */
 	std::string syntax;
 
+	/** Translation type list for possible parameters, used to tokenize
+	 * parameters into UIDs and SIDs etc.
+	 */
 	std::vector<TranslateType> translation;
 
 	/** How many seconds worth of penalty does this command have?
@@ -195,6 +203,8 @@ class CoreExport Command : public Extensible
  */
 typedef nspace::hash_map<std::string,Command*> Commandtable;
 
+/** Shortcut macros for defining translation lists
+ */
 #define TRANSLATE1(x1)	translation.push_back(x1);
 #define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
 #define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);