Replaced some of the 'autoconverted - document me' strings
authorArt Cancro <ajc@citadel.org>
Sun, 24 Oct 2010 03:20:49 +0000 (23:20 -0400)
committerArt Cancro <ajc@citadel.org>
Sun, 24 Oct 2010 03:20:49 +0000 (23:20 -0400)
citadel/euidindex.c
citadel/modules/expire/serv_expire.c
citadel/room_ops.c
citadel/user_ops.c

index 8ca39ee0e18e7588504af32b365932475c1c6710..a39881bac6adafcc6849ce30955f9316c6483ec0 100644 (file)
@@ -257,7 +257,7 @@ void cmd_euid(char *cmdbuf) {
 CTDL_MODULE_INIT(euidindex)
 {
        if (!threading) {
-               CtdlRegisterProtoHook(cmd_euid, "EUID", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_euid, "EUID", "Perform operations on Extended IDs for messages");
        }
        /* return our Subversion id for the Log */
        return "euidindex";
index b78498efb3db7eb4781d9604d71537d9cc0510d1..b08fb974fca7a1054c8d8abcbbdf90acbe09eae7 100644 (file)
@@ -1051,8 +1051,8 @@ CTDL_MODULE_INIT(expire)
                /* CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts"); */
                CtdlRegisterProtoHook(cmd_tdap, "TDAP", "Manually initiate auto-purger");
 
-               CtdlRegisterProtoHook(cmd_gpex, "GPEX", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_spex, "SPEX", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_gpex, "GPEX", "Get expire policy");
+               CtdlRegisterProtoHook(cmd_spex, "SPEX", "Set expire policy");
        }
        else
                CtdlThreadCreate("Auto Purger", CTDLTHREAD_BIGSTACK, purge_databases, NULL);
index 9aa14741ca4aa3035455f753464242da5cc92328..c6801b6d352b2d7f4c4e665eedd9fa71d64add9f 100644 (file)
@@ -2260,22 +2260,22 @@ void cmd_eflr(char *argbuf)
 CTDL_MODULE_INIT(room_ops)
 {
        if (!threading) {
-               CtdlRegisterProtoHook(cmd_lrms, "LRMS", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_lkra, "LKRA", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_lkrn, "LKRN", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_lkro, "LKRO", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_lzrm, "LZRM", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_lrms, "LRMS", "List rooms");
+               CtdlRegisterProtoHook(cmd_lkra, "LKRA", "List all known rooms");
+               CtdlRegisterProtoHook(cmd_lkrn, "LKRN", "List known rooms with new messages");
+               CtdlRegisterProtoHook(cmd_lkro, "LKRO", "List known rooms without new messages");
+               CtdlRegisterProtoHook(cmd_lzrm, "LZRM", "List zapped rooms");
                CtdlRegisterProtoHook(cmd_lprm, "LPRM", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_goto, "GOTO", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_whok, "WHOK", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_rdir, "RDIR", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_goto, "GOTO", "Goto a named room");
+               CtdlRegisterProtoHook(cmd_whok, "WHOK", "List users who know this room");
+               CtdlRegisterProtoHook(cmd_rdir, "RDIR", "List files in room directory");
                CtdlRegisterProtoHook(cmd_getr, "GETR", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_setr, "SETR", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_geta, "GETA", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_seta, "SETA", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_rinf, "RINF", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_kill, "KILL", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_cre8, "CRE8", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_cre8, "CRE8", "Create a new room");
                CtdlRegisterProtoHook(cmd_einf, "EINF", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_lflr, "LFLR", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_cflr, "CFLR", "Autoconverted. TODO: document me.");
index 989ce41b9ddfdd8c4d953b6a2d1fa4dbcf8d1986..2737c0446d78111af898ba3506d897fdd851afdb 100644 (file)
@@ -2056,19 +2056,19 @@ void cmd_renu(char *cmdbuf)
 CTDL_MODULE_INIT(user_ops)
 {
        if (!threading) {
-               CtdlRegisterProtoHook(cmd_user, "USER", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_pass, "PASS", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_creu, "CREU", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_setp, "SETP", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_getu, "GETU", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_setu, "SETU", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_slrp, "SLRP", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_invt, "INVT", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_kick, "KICK", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_forg, "FORG", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_user, "USER", "Submit username for login");
+               CtdlRegisterProtoHook(cmd_pass, "PASS", "Complete login by submitting a password");
+               CtdlRegisterProtoHook(cmd_creu, "CREU", "Create User");
+               CtdlRegisterProtoHook(cmd_setp, "SETP", "Set the password for an account");
+               CtdlRegisterProtoHook(cmd_getu, "GETU", "Get User parameters");
+               CtdlRegisterProtoHook(cmd_setu, "SETU", "Set User parameters");
+               CtdlRegisterProtoHook(cmd_slrp, "SLRP", "Set Last Read Pointer");
+               CtdlRegisterProtoHook(cmd_invt, "INVT", "Invite a user to a room");
+               CtdlRegisterProtoHook(cmd_kick, "KICK", "Kick a user out of a room");
+               CtdlRegisterProtoHook(cmd_forg, "FORG", "Forget a room");
                CtdlRegisterProtoHook(cmd_gnur, "GNUR", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_vali, "VALI", "Autoconverted. TODO: document me.");
-               CtdlRegisterProtoHook(cmd_list, "LIST", "Autoconverted. TODO: document me.");
+               CtdlRegisterProtoHook(cmd_vali, "VALI", "Validate new users");
+               CtdlRegisterProtoHook(cmd_list, "LIST", "List users");
                CtdlRegisterProtoHook(cmd_chek, "CHEK", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_qusr, "QUSR", "Autoconverted. TODO: document me.");
                CtdlRegisterProtoHook(cmd_agup, "AGUP", "Autoconverted. TODO: document me.");