From 92bd051b4d3877757e094b572e11ff2dda333d38 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Rafa=C5=82=20D=C5=82ugo=C5=82=C4=99cki?= Date: Sat, 30 Jan 2016 22:15:53 +0100 Subject: [PATCH] Documentation fixes --- src/edit/FindDialog.h | 4 + src/edit/PreferencesDialog.h | 4 + src/edit/ProgramStructureDialog.h | 4 + src/edit/UnitStructureDialog.h | 4 + src/edit/editor.h | 4 + src/global/comm.h | 56 ++++++---- src/global/genint1.h | 4 + src/int/cint.c | 34 +++++-- src/int/execute.c | 7 +- src/int/genint.h | 4 +- src/int/intdt.c | 11 +- src/int/memory.c | 3 +- src/int/nonstand.c | 6 +- src/int/nonstand.h | 163 +++++++++++++++++++----------- src/int/object.c | 6 +- src/int/procaddr.c | 19 ++-- src/int/process.c | 5 +- src/int/process.h | 45 ++++++--- src/int/queue.c | 3 + src/int/rpcall.c | 3 + src/int/runsys.c | 4 + src/int/standard.c | 7 +- src/int/typchk.c | 15 ++- src/int/util.c | 15 ++- src/kernel/ConnectDialog.h | 4 + src/kernel/KillDialog.h | 4 + src/kernel/LockDialog.h | 4 + src/kernel/MessageDialog.h | 4 + src/kernel/OptionsDialog.h | 4 + src/kernel/kernel.h | 3 + src/lgconfig/AddNodeDialog.h | 4 + src/lgconfig/NodeListDialog.h | 4 + src/lgconfig/lgconfig.h | 4 + 33 files changed, 331 insertions(+), 134 deletions(-) diff --git a/src/edit/FindDialog.h b/src/edit/FindDialog.h index 50f91b6..9023808 100644 --- a/src/edit/FindDialog.h +++ b/src/edit/FindDialog.h @@ -7,6 +7,10 @@ #include "ui/dialogs/FindDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/edit/PreferencesDialog.h b/src/edit/PreferencesDialog.h index 076681c..0bb4a0c 100644 --- a/src/edit/PreferencesDialog.h +++ b/src/edit/PreferencesDialog.h @@ -6,6 +6,10 @@ #include "ui/dialogs/PreferencesDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/edit/ProgramStructureDialog.h b/src/edit/ProgramStructureDialog.h index 578a08e..278b6d3 100644 --- a/src/edit/ProgramStructureDialog.h +++ b/src/edit/ProgramStructureDialog.h @@ -7,6 +7,10 @@ #include "ui/dialogs/ProgramStructureDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/edit/UnitStructureDialog.h b/src/edit/UnitStructureDialog.h index a31a147..4f96bd3 100644 --- a/src/edit/UnitStructureDialog.h +++ b/src/edit/UnitStructureDialog.h @@ -6,6 +6,10 @@ #include "ui/dialogs/UnitStructureDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/edit/editor.h b/src/edit/editor.h index 9ff52a5..e7c0c34 100644 --- a/src/edit/editor.h +++ b/src/edit/editor.h @@ -9,6 +9,10 @@ #include "ui/editor.h" +/** + * @file + */ + namespace loglan { namespace vlp { diff --git a/src/global/comm.h b/src/global/comm.h index 27e754d..d9969a2 100644 --- a/src/global/comm.h +++ b/src/global/comm.h @@ -1,4 +1,7 @@ -/* Communication structures */ +/** + * @file + * @brief Communication structures + */ #ifndef LOGLAN_COMM_H #define LOGLAN_COMM_H @@ -15,10 +18,10 @@ typedef struct { } paddr; typedef struct { - paddr sender; /* address of the sender and */ - paddr receiver; /* receiver of the message */ - int type; /* message type */ - int par; /* prototype or error signal number */ + paddr sender; /** address of the sender and */ + paddr receiver; /** receiver of the message */ + int type; /** message type */ + int par; /** prototype or error signal number */ } ctrl_msg; typedef struct { @@ -37,8 +40,11 @@ typedef struct { int program_id; } ctx_struct; -/* Commm struct for GRAPH element */ - +/** + * \defgroup GRAPH + * \brief Comm struct for GRAPH element + */ +/** @{ */ #define GRAPH_ALLOCATE 1 #define GRAPH_EXIT 2 #define GRAPH_FREE 3 @@ -80,9 +86,13 @@ typedef struct { #define GRAPH_MAGIC 37 #define GRAPH_MAGIC_RESPONSE 38 +/** @} */ -/* INT element */ - +/** + * \defgroup INT + * \brief Comm struct for INT element + */ +/** @{ */ #define INT_CONNECTED 1 #define INT_EXITING 2 #define INT_CTX 3 @@ -93,11 +103,13 @@ typedef struct { #define INT_CLOSE_INSTANCE 8 #define INT_KILL 9 #define INT_START_OK 10 +/** @} */ - - -/* NET element */ - +/** + * \defgroup NET + * \brief Comm struct for NET element + */ +/** @{ */ #define NET_PROPAGATE 0 #define NET_PROPAGATE_OUT 1 /* @@ -144,9 +156,13 @@ typedef struct { #define NET_INFO_END 25 #define NET_NODES_NUM 26 #define NET_NODES_NUM_RESPONSE 27 +/** @} */ -/* VLP message */ - +/** + * \defgroup VLP + * \brief VLP message + */ +/** @{ */ #define VLP_WRITE 0 #define VLP_REMOTE_INSTANCE 1 #define VLP_REMOTE_INSTANCE_OK 2 @@ -155,10 +171,13 @@ typedef struct { #define VLP_REMOTE_INSTANCE_HERE 5 #define VLP_CLOSE_INSTANCE 6 #define VLP_INTERPRETER_DOWN 7 -/* ------------------------------------------------------------ */ -/* Message structure */ -/*------------------------------------------------------------*/ +/** @} */ +/** + * \defgroup VLP + * \brief Message structure + */ +/** @{ */ #define MSG_VLP 0 #define MSG_NET 1 #define MSG_GRAPH 2 @@ -177,5 +196,6 @@ typedef struct { } G_MESSAGE; #define TCP_BUFFER_SIZE 30*sizeof(MESSAGE); +/** @} */ #endif /* LOGLAN_COMM_H */ diff --git a/src/global/genint1.h b/src/global/genint1.h index c098f2a..3a4ab71 100644 --- a/src/global/genint1.h +++ b/src/global/genint1.h @@ -31,6 +31,10 @@ or Andrzej Salwicki #ifndef __GENINT_H #define __GENINT_H +/** + * @file + */ + #if GEN #define word address #endif diff --git a/src/int/cint.c b/src/int/cint.c index ce16846..e67e8b6 100644 --- a/src/int/cint.c +++ b/src/int/cint.c @@ -1,5 +1,3 @@ - - #include "depend.h" #include "genint.h" #include "int.h" @@ -25,7 +23,10 @@ static void initiate(); int main(); #endif - +/** + * @file + * @brief Compiler and interpreter code + */ int internal_sock, graph_sock, net_sock, connected = 0; struct sockaddr_un svr; @@ -154,6 +155,12 @@ static void load(char *_filename) /** * Establishes configuration parameters * Creates two sockets for program run + * + * @param argc number of passed values in argv array + * @param argv[1] + * @param argv[2] + * @param argv[3] if value is equal to: "r", sets global #remote variable to + * TRUE, FALSE otherwise */ static void initiate(int argc, char **argv) { @@ -249,7 +256,7 @@ static void initiate(int argc, char **argv) /** * */ -void decode(){ +void decode() { extopcode *eop; /* pointer to extended opcode in M */ @@ -295,6 +302,7 @@ int read_from_graph(G_MESSAGE *msg) /** * Reads message from net module. + * * @param msg Message to read. */ int read_from_net(MESSAGE *msg) @@ -315,7 +323,7 @@ int read_from_net(MESSAGE *msg) } -/** +/** * Gets graphic resource number */ int get_graph_res() @@ -378,6 +386,9 @@ void writeln_str(char *s) /** * Writes string + * + * Passed string is send to graph module by G_MESSAGE packet using send_to_graph + * * @param s String to write */ void write_str(char *s) @@ -392,6 +403,9 @@ void write_str(char *s) /** * Writes char + * + * Passed char is send to graph module by G_MESSAGE packet using send_to_graph + * * @param a Character to write */ void write_char(char a) @@ -728,7 +742,9 @@ void request_id() send_to_graph(&m1); } - +/** + * Sends MESSAGE + */ void send_ready() { int sock, len; @@ -771,12 +787,12 @@ void send_ready() * strcpy(filename, argv[2]); * strcpy(ProgName, argv[2]); * - * argv[1] = base name of this interpreter instance. + * @param argv[1] = base name of this interpreter instance. * For network there is created argv[1].net socket * For graphics there is created argv[1].gr socket - * argv[2] = up to 80 characters string (with terminating \0). It is used to + * @param argv[2] = up to 80 characters string (with terminating \0). It is used to * load selected program - * argv[3] = if exists and is equal to 'r', this is a remote call + * @param argv[3] = if exists and is equal to 'r', this is a remote call */ int main(int argc, char **argv) { diff --git a/src/int/execute.c b/src/int/execute.c index f9d0f91..beb4fe6 100644 --- a/src/int/execute.c +++ b/src/int/execute.c @@ -36,10 +36,11 @@ or Andrzej Salwicki #include +/** + * @file + */ -/* Execute one L-code instruction */ - - +/** Execute one L-code instruction */ void execute() { word t1, t2; diff --git a/src/int/genint.h b/src/int/genint.h index a974c3f..0481021 100644 --- a/src/int/genint.h +++ b/src/int/genint.h @@ -34,7 +34,9 @@ or Andrzej Salwicki #include "genint1.h" - +/** + * @file + */ /* Variables : */ extern protdescr *prototype[]; diff --git a/src/int/intdt.c b/src/int/intdt.c index 1e46b4f..9c2c6f2 100644 --- a/src/int/intdt.c +++ b/src/int/intdt.c @@ -4,6 +4,10 @@ #include "process.h" #include "intproto.h" +/** + * @file + */ + /** * \defgroup Variables common with generator : * @{ @@ -174,9 +178,10 @@ int opcode; word a1, a2, a3; /** - * \defgroup kernel variables for the running system: + * \defgroup kernel + * \brief variables for the running system */ -/**@{*/ +/** @{ */ /** * code and data memory size */ @@ -215,7 +220,7 @@ word mainprog; **/ word mnoff; -/**@}*/ +/** @} */ /** * default: no compactification message diff --git a/src/int/memory.c b/src/int/memory.c index 19e41a8..3c239eb 100644 --- a/src/int/memory.c +++ b/src/int/memory.c @@ -5,7 +5,8 @@ #include "intproto.h" /** - * @file Memory management routines + * @file + * @brief Memory management routines */ #ifndef NO_PROTOTYPES diff --git a/src/int/nonstand.c b/src/int/nonstand.c index 6c05361..1c373f7 100644 --- a/src/int/nonstand.c +++ b/src/int/nonstand.c @@ -7,8 +7,10 @@ #include "nonstand.h" -/* Call (non)standard procedures. - * Almost totaly implementation dependent. +/** + * @file + * @brief Call (non)standard procedures. + * @brief Almost totaly implementation dependent. */ /** TRUE if graphics mode active */ diff --git a/src/int/nonstand.h b/src/int/nonstand.h index 13144a2..88565ce 100644 --- a/src/int/nonstand.h +++ b/src/int/nonstand.h @@ -1,105 +1,152 @@ -/* Standard class IIUWGRAPH graphics primitives - -GRON:procedure(mode:integer) -GROFF:procedure -CLS:procedure -POINT:procedure(x, y:integer) -MOVE:procedure(x, y:integer) -DRAW:procedure(x, y:integer) -HFILL:procedure(x:integer) -VFILL:procedure(y:integer) -COLOR:procedure(color:integer) -STYLE:procedure(style:integer) -PATERN:procedure(p1, p2, p3, p4:integer) -INTENS:procedure(intens:integer) -PALLET:procedure(p:integer) -BORDER:procedure(b:integer) -VIDEO:procedure(buffer:arrayof integer) -HPAGE:procedure(p, q, r:integer) -NOCARD:function:integer -PUSHXY:procedure -POPXY:procedure -INXPOS:function:integer -INYPOS:function:integer -INPIX:function(x, y:integer):integer -GETMAP:function(x, y:integer):arrayof integer -PUTMAP:procedure(arrayof integer) -ORMAP:procedure(arrayof integer) -XORMAP:procedure(arrayof integer) -TRACK:procedure(x, y:integer) -INKEY:function:integer -HASCII:procedure(ch:integer) -HFONT:procedure(off, seg:integer) -HFONT8:procedure(output off, seg:integer) -OUTSTRING:procedure(s:string) -CIRB:procedure(x, y, r:integer, alpha, beta:real, b, i, p, q:integer) - -*/ - +/** + * @file + */ +/** + * @defgroup IIUWGRAPH + * @brief Standard class IIUWGRAPH graphics primitives + */ +/** @{ */ +/** GRON:procedure(mode:integer) */ #define GRON 100 + +/** GROFF:procedure */ #define GROFF 101 + +/** CLS:procedure */ #define CLS 102 + +/** POINT:procedure(x, y:integer) */ #define POINT 103 + +/** MOVE:procedure(x, y:integer) */ #define MOVE 104 + +/** DRAW:procedure(x, y:integer) */ #define DRAW 105 + +/** HFILL:procedure(x:integer) */ #define HFILL 106 + +/** VFILL:procedure(y:integer) */ #define VFILL 107 + +/** COLOR:procedure(color:integer) */ #define COLOR 108 + +/** STYLE:procedure(style:integer) */ #define STYLE 109 + +/** PATERN:procedure(p1, p2, p3, p4:integer) */ #define PATERN 110 + +/** INTENS:procedure(intens:integer) */ #define INTENS 111 + +/** PALLET:procedure(p:integer) */ #define PALLET 112 + +/** BORDER:procedure(b:integer) */ #define BORDER 113 + +/** VIDEO:procedure(buffer:arrayof integer) */ #define VIDEO 114 + +/** HPAGE:procedure(p, q, r:integer) */ #define HPAGE 115 + +/** NOCARD:function:integer */ #define NOCARD 116 + +/** PUSHXY:procedure */ #define PUSHXY 117 + +/** POPXY:procedure */ #define POPHXY 118 + +/** INXPOS:function:integer */ #define INXPOS 119 + +/** INYPOS:function:integer */ #define INYPOS 120 + +/** INPIX:function(x, y:integer):integer */ #define INPIX 121 + +/** GETMAP:function(x, y:integer):arrayof integer */ #define GETMAP 122 + +/** PUTMAP:procedure(arrayof integer) */ #define PUTMAP 123 + +/** ORMAP:procedure(arrayof integer) */ #define ORMAP 124 + +/** XORMAP:procedure(arrayof integer) */ #define XORMAP 125 + +/** TRACK:procedure(x, y:integer) */ #define TRACK 126 + +/** INKEY:function:integer */ #define INKEY 127 -#define HASCII 128 -#define HFONT 129 -#define HFONT8 130 -#define OUTSTRING 131 -#define CIRB 132 +/** HASCII:procedure(ch:integer) */ +#define HASCII 128 -/* Standard class MOUSE mouse support +/** HFONT:procedure(off, seg:integer) */ +#define HFONT 129 -INIT:function(output butttons:integer):boolean -SHOWCURSOR:procedure -HIDECURSOR:procedure -STATUS:procedure(output x,y:integer, l,r,c:boolean) -SETPOSITION:procedure(x, y:integer) -GETPRESS:procedure(b:integer; output x,y,p:integer, l, r, c:boolean) -GETRELEASE:procedure(b:integer; output x,y,p:integer, l, r, c:boolean) -SETWINDOW:procedure(l, r, t, b:integer) -DEFCURSOR:procedure(select, p, q:integer) -GETMOVEMENT:procedure(output x, y:integer) -SETSPEED:procedure(x, y:integer) -SETMARGINS:procedure(l, r, t, b:integer) -SETTHRESHOLD:procedure(t:integer) +/** HFONT8:procedure(output off, seg:integer) */ +#define HFONT8 130 -*/ +/** OUTSTRING:procedure(s:string) */ +#define OUTSTRING 131 +/** CIRB:procedure(x, y, r:integer, alpha, beta:real, b, i, p, q:integer) */ +#define CIRB 132 +/** @} */ +/** + * @defgroup MOUSE + * @brief Standard class MOUSE mouse support + */ +/** @{ */ +/** INIT:function(output butttons:integer):boolean */ #define INIT 200 + +/** SHOWCURSOR:procedure */ #define SHOWCURSOR 201 + +/** HIDECURSOR:procedure */ #define HIDECURSOR 202 + +/** STATUS:procedure(output x,y:integer, l,r,c:boolean) */ #define STATUS 203 + +/** SETPOSITION:procedure(x, y:integer) */ #define SETPOSITION 204 + +/** GETPRESS:procedure(b:integer; output x,y,p:integer, l, r, c:boolean) */ #define GETPRESS 205 + +/** GETRELEASE:procedure(b:integer; output x,y,p:integer, l, r, c:boolean) */ #define GETRELEASE 206 + +/** SETWINDOW:procedure(l, r, t, b:integer) */ #define SETWINDOW 207 + +/** DEFCURSOR:procedure(select, p, q:integer) */ #define DEFCURSOR 210 + +/** GETMOVEMENT:procedure(output x, y:integer) */ #define GETMOVEMENT 211 + +/** SETSPEED:procedure(x, y:integer) */ #define SETSPEED 215 + +/** SETMARGINS:procedure(l, r, t, b:integer) */ #define SETMARGINS 216 + +/** SETTHRESHOLD:procedure(t:integer) */ #define SETTHRESHOLD 219 +/** @} */ diff --git a/src/int/object.c b/src/int/object.c index 33168d3..817eaac 100644 --- a/src/int/object.c +++ b/src/int/object.c @@ -4,7 +4,11 @@ #include "process.h" #include "intproto.h" -/* object management routines */ + +/** + * @file + * @brief object management routines + */ /** * Open new field for a record. diff --git a/src/int/procaddr.c b/src/int/procaddr.c index 8ae23aa..00d0084 100644 --- a/src/int/procaddr.c +++ b/src/int/procaddr.c @@ -11,15 +11,16 @@ #define staddr(node, pix) ((word) ((pix << 8) | node)) -/* - These are converters from global to process pointers in memory - to global process pointers in message. - M denotes memory in which pair (pointer,object) exists or has to exist. - We want to create object denoting remote process instead of - dummy pointer without object. - The object will be like an arrayof integer of size 2. - arr[1..3] : arr[1]=node, arr[2]=pix. -*/ +/** + * @file + * These are converters from global to process pointers in memory + * to global process pointers in message. + * M denotes memory in which pair (pointer,object) exists or has to exist. + * We want to create object denoting remote process instead of + * dummy pointer without object. + * The object will be like an arrayof integer of size 2. + * arr[1..3] : arr[1]=node, arr[2]=pix. + */ void obj2mess(word *M, virtaddr *obj, procaddr *mess) { diff --git a/src/int/process.c b/src/int/process.c index d836a25..30997cb 100644 --- a/src/int/process.c +++ b/src/int/process.c @@ -13,7 +13,10 @@ #include -/* Process management */ +/** + * @file + * @brief Process management + */ /** process descriptor table */ procdescr process[MAXPROCESS]; diff --git a/src/int/process.h b/src/int/process.h index 22fe056..7644da9 100644 --- a/src/int/process.h +++ b/src/int/process.h @@ -1,35 +1,50 @@ #include "queue.h" -/* Process management definitions : */ -/* maximum number of processes on one node */ +/** + * @defgroup + * @brief Process management definitions + */ +/** @{ */ + +/** maximum number of processes on one node */ #define MAXPROCESS 64 -/* maximum number of waiting messages */ + +/** maximum number of waiting messages */ #define MAXMSGQUEUE 16 -/* message length defined by me (PS) */ +/** message length defined by me (PS) */ #define MSGLENGTH 256 +/** @} */ - -/* Process state : */ - +/** + * @defgroup + * @brief Process states + */ +/** @{ */ /* during generation of process object */ #define GENERATING 0 -/* non-active process (suspended by STOP) */ + +/** non-active process (suspended by STOP) */ #define STOPPED 1 -/* active process (ready to execute) */ + +/** active process (ready to execute) */ #define EXECUTING 2 -/* waiting for NEW of another process */ + +/** waiting for NEW of another process */ #define WAITFORNEW 3 -/* waiting for remote procedure call */ + +/** waiting for remote procedure call */ #define WAITFORRPC 4 -/* during execution of ACCEPT statement */ + +/** during execution of ACCEPT statement */ #define ACCEPTING 5 -/* waiting for process prototype */ -#define WAITASKPRO 6 -/* Process descriptor : */ +/** waiting for process prototype */ +#define WAITASKPRO 6 +/** @} */ +/** Process descriptor */ typedef struct { /* TRUE if in use by some process */ diff --git a/src/int/queue.c b/src/int/queue.c index cbb91bc..7189ce3 100644 --- a/src/int/queue.c +++ b/src/int/queue.c @@ -5,6 +5,9 @@ #include "intproto.h" +/** + * @file + */ /* Queue management */ /* Single linked circular lists with queue represented as pointer to rear */ diff --git a/src/int/rpcall.c b/src/int/rpcall.c index 49db727..04873db 100644 --- a/src/int/rpcall.c +++ b/src/int/rpcall.c @@ -4,6 +4,9 @@ #include "process.h" #include "intproto.h" +/** + * @file + */ #ifndef NO_PROTOTYPES static bool isenabled(word,word); diff --git a/src/int/runsys.c b/src/int/runsys.c index 6ff0c81..77d6978 100644 --- a/src/int/runsys.c +++ b/src/int/runsys.c @@ -34,6 +34,10 @@ or Andrzej Salwicki #include "process.h" #include "intproto.h" +/** + * @file + */ + /** * Initialize memory structures for objects, main object and a few goodies more. */ diff --git a/src/int/standard.c b/src/int/standard.c index e865220..f676d36 100644 --- a/src/int/standard.c +++ b/src/int/standard.c @@ -37,9 +37,12 @@ or Andrzej Salwicki #include #include -/* Call standard procedure */ +/** + * @file + * @brief Call standard procedure + */ -/* Process call to a standard proc. */ +/** Process call to a standard proc. */ void standard(word nrproc) { word t1, t2, t3, t5, t6; diff --git a/src/int/typchk.c b/src/int/typchk.c index 2a70407..fb9f498 100644 --- a/src/int/typchk.c +++ b/src/int/typchk.c @@ -34,10 +34,9 @@ or Andrzej Salwicki #include "process.h" #include "intproto.h" -/* Type checking routines */ - - -/* Determine if prot occurs in the prefix sequence of object am +/** + * @defgroup + * @brief Type checking routines */ #ifndef NO_PROTOTYPES @@ -52,7 +51,7 @@ static bool prefh(); static bool typef(); #endif - +/** Determine if prot occurs in the prefix sequence of object am */ static bool pref(word am, word prot) { word t1, t2; @@ -73,7 +72,7 @@ static bool pref(word am, word prot) return FALSE; } -/* Validate qualification of object */ +/** Validate qualification of object */ void qua(virtaddr *virt, word tp) { if (virt->mark != M[virt->addr + 1]) @@ -84,7 +83,7 @@ void qua(virtaddr *virt, word tp) errsignal(RTEINCQA); } -/* Determine if A in B */ +/** Determine if A in B */ bool inl(virtaddr *virt, word tp) { /* none is in everything */ @@ -96,7 +95,7 @@ bool inl(virtaddr *virt, word tp) return pref(M[virt->addr], M[tp + 1]); } -/* Determine if A is B */ +/** Determine if A is B */ bool is(virtaddr *virt, word tp) { if (virt->mark != M[virt->addr + 1] || M[tp] != CLASSTYPE) diff --git a/src/int/util.c b/src/int/util.c index 96d6885..898587d 100644 --- a/src/int/util.c +++ b/src/int/util.c @@ -37,7 +37,10 @@ or Andrzej Salwicki #include -/* Utility routines */ +/** + * @file + * @brief Utility routines + */ /** * Compute entier (floor) @@ -136,7 +139,7 @@ void abend(char *msg) static int ranpat1 = 7, ranpat2 = 503, ranpat3 = 15661; /** - * Initialize generator + * Initializes random number generator */ void ranset() { @@ -149,7 +152,9 @@ void ranset() } /** - * Produce next pseudo random number + * Produces next pseudo random number + * + * @see ranset must be invoked before running this function */ double prandom() { @@ -177,6 +182,10 @@ double prandom() /** * Copy a block of memory + * + * @param from[in] source block to copy from + * @param to[out] destination block to copy to + * @param len number of character to copy */ void moveblock(char *from, char *to, word len) { diff --git a/src/kernel/ConnectDialog.h b/src/kernel/ConnectDialog.h index 58cd994..e55dd88 100644 --- a/src/kernel/ConnectDialog.h +++ b/src/kernel/ConnectDialog.h @@ -6,6 +6,10 @@ #include "ui/dialogs/ConnectDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/kernel/KillDialog.h b/src/kernel/KillDialog.h index 2e0f931..53b821c 100644 --- a/src/kernel/KillDialog.h +++ b/src/kernel/KillDialog.h @@ -5,6 +5,10 @@ #include "ui/dialogs/KillDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/kernel/LockDialog.h b/src/kernel/LockDialog.h index 7ddd6ac..d8c1cfc 100644 --- a/src/kernel/LockDialog.h +++ b/src/kernel/LockDialog.h @@ -5,6 +5,10 @@ #include "ui/dialogs/LockDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/kernel/MessageDialog.h b/src/kernel/MessageDialog.h index cb9d149..95ab8fc 100644 --- a/src/kernel/MessageDialog.h +++ b/src/kernel/MessageDialog.h @@ -5,6 +5,10 @@ #include "ui/dialogs/MessageDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/kernel/OptionsDialog.h b/src/kernel/OptionsDialog.h index 6459295..f55aabf 100644 --- a/src/kernel/OptionsDialog.h +++ b/src/kernel/OptionsDialog.h @@ -5,6 +5,10 @@ #include "ui/dialogs/OptionsDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/kernel/kernel.h b/src/kernel/kernel.h index aaef05d..fdb7606 100644 --- a/src/kernel/kernel.h +++ b/src/kernel/kernel.h @@ -54,6 +54,9 @@ #define WARN_COL 1 #define NORM_COL 2 +/** + * @file + */ namespace loglan { namespace vlp { diff --git a/src/lgconfig/AddNodeDialog.h b/src/lgconfig/AddNodeDialog.h index 14e1bca..9a758d4 100644 --- a/src/lgconfig/AddNodeDialog.h +++ b/src/lgconfig/AddNodeDialog.h @@ -6,6 +6,10 @@ #include "ui/dialogs/AddNodeDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/lgconfig/NodeListDialog.h b/src/lgconfig/NodeListDialog.h index 9967ae3..e75e632 100644 --- a/src/lgconfig/NodeListDialog.h +++ b/src/lgconfig/NodeListDialog.h @@ -9,6 +9,10 @@ #include "ui/dialogs/NodeListDialog.h" +/** + * @file + */ + namespace loglan { namespace vlp { namespace dialog { diff --git a/src/lgconfig/lgconfig.h b/src/lgconfig/lgconfig.h index c19e0cf..e303582 100644 --- a/src/lgconfig/lgconfig.h +++ b/src/lgconfig/lgconfig.h @@ -6,6 +6,10 @@ #include "ui/VLPConfigWindow.h" +/** + * @file + */ + namespace loglan { namespace vlp { -- 2.30.2