Documentation fixes
authorRafał Długołęcki <rafal@dlugolecki.net.pl>
Sat, 30 Jan 2016 21:15:53 +0000 (22:15 +0100)
committerRafał Długołęcki <rafal@dlugolecki.net.pl>
Sat, 30 Jan 2016 21:15:53 +0000 (22:15 +0100)
33 files changed:
src/edit/FindDialog.h
src/edit/PreferencesDialog.h
src/edit/ProgramStructureDialog.h
src/edit/UnitStructureDialog.h
src/edit/editor.h
src/global/comm.h
src/global/genint1.h
src/int/cint.c
src/int/execute.c
src/int/genint.h
src/int/intdt.c
src/int/memory.c
src/int/nonstand.c
src/int/nonstand.h
src/int/object.c
src/int/procaddr.c
src/int/process.c
src/int/process.h
src/int/queue.c
src/int/rpcall.c
src/int/runsys.c
src/int/standard.c
src/int/typchk.c
src/int/util.c
src/kernel/ConnectDialog.h
src/kernel/KillDialog.h
src/kernel/LockDialog.h
src/kernel/MessageDialog.h
src/kernel/OptionsDialog.h
src/kernel/kernel.h
src/lgconfig/AddNodeDialog.h
src/lgconfig/NodeListDialog.h
src/lgconfig/lgconfig.h

index 50f91b63e8ee82bb8abf3c431c3eeaad0d8f5824..9023808124d7635956e20b7d8f64271c8e0311e6 100644 (file)
@@ -7,6 +7,10 @@
 
 #include "ui/dialogs/FindDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 076681c471d44f1556a3d8a1721cb7715113a848..0bb4a0c5180d1c3470da19948078bebcecabdeb2 100644 (file)
@@ -6,6 +6,10 @@
 
 #include "ui/dialogs/PreferencesDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 578a08e261eb2071e1d01caab6cff85e1d193fef..278b6d3c4fc1a45838c749eedbc75732e5267323 100644 (file)
@@ -7,6 +7,10 @@
 
 #include "ui/dialogs/ProgramStructureDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index a31a147ccaa3be7f945603a986299823b6ffbfb4..4f96bd31916399d5cac63a687121f7cf0088e3d8 100644 (file)
@@ -6,6 +6,10 @@
 
 #include "ui/dialogs/UnitStructureDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 9ff52a58a9fcb57754359816c84d72b9d9f96555..e7c0c3442677ddbff09a5192e75f8a67e250508d 100644 (file)
@@ -9,6 +9,10 @@
 
 #include "ui/editor.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 
index 27e754d3cea1527c0615d14bb359778b5ef1fc36..d9969a2f400587f09fc830d94f78330fb79d2017 100644 (file)
@@ -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 */
index c098f2a1ed76ee5c71b650fdd9705fa3c19c60c4..3a4ab718768a3a3e1ec0a7a6db2e845d43aeac00 100644 (file)
@@ -31,6 +31,10 @@ or             Andrzej Salwicki
 #ifndef __GENINT_H
 #define __GENINT_H
 
+/**
+ * @file
+ */
+
 #if GEN
 #define word address
 #endif
index ce16846e08f5a6ca442829709d136b2b54c1b3ce..e67e8b6c10d86ee6fc4df0c261a5551893a2f59f 100644 (file)
@@ -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)
 {
index f9d0f91a56478a2dc6547901728406bf526167fb..beb4fe6965e483873c4300543cd18f44742f65e9 100644 (file)
@@ -36,10 +36,11 @@ or             Andrzej Salwicki
 
 #include <assert.h>
 
+/**
+ * @file
+ */
 
-/* Execute one L-code instruction */
-
-
+/** Execute one L-code instruction */
 void execute()
 {
        word t1, t2;
index a974c3f2c1955d51f7c1283d7de1578e584bfbc3..0481021f81e59141a88fa1b0aacec4bf552f45a8 100644 (file)
@@ -34,7 +34,9 @@ or             Andrzej Salwicki
 
 #include "genint1.h"
 
-
+/**
+ * @file
+ */
 /* Variables : */
 
 extern protdescr *prototype[];
index 1e46b4f78783c2e5f104d6857d7148fe5208c0ff..9c2c6f2bf5673a05df2670e62868a50763b99287 100644 (file)
@@ -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
index 19e41a8323b5225d13107c3cd76e439ca1bedec9..3c239ebd451550ef6ef78feec709494243d6865e 100644 (file)
@@ -5,7 +5,8 @@
 #include "intproto.h"
 
 /**
- * @file Memory management routines
+ * @file
+ * @brief Memory management routines
  */
 
 #ifndef NO_PROTOTYPES
index 6c05361d13d2208eef26c6ce8a5109e19e1829ce..1c373f7055eb3bb0b94e23103ff91cd7856be040 100644 (file)
@@ -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 */
index 13144a2d7f7703165d11d577334fa54198825580..88565ce0e603d9b957718082991872b3d1b41827 100644 (file)
-/* 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
+/** @} */
index 33168d3b3cfeb378fc64806c30d524715de096d5..817eaacf1623e3729653d497cdc1c0ea84e87a14 100644 (file)
@@ -4,7 +4,11 @@
 #include "process.h"
 #include "intproto.h"
 
-/* object management routines */
+
+/**
+ * @file
+ * @brief object management routines
+ */
 
 /**
  * Open new field for a record.
index 8ae23aa9fb6d4eb20771536a1986fc2ff70abd1e..00d0084be29d7beb8de209e8bf0fdc359e7896af 100644 (file)
 #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)
 {
index d836a2571f1aee9ac63d24be55f2e664015006a7..30997cb2d251a6418e9fff33b40d8507da76297b 100644 (file)
 #include <assert.h>
 
 
-/* Process management */
+/**
+ * @file
+ * @brief Process management
+ */
 
 /** process descriptor table */
 procdescr process[MAXPROCESS];
index 22fe05626334609f4db687522b4dc37299d29959..7644da9d3db2dd2b262795ee4c9673f050caad8d 100644 (file)
@@ -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 */
index cbb91bc979dc54ca42ec900172fa3ddc6ab61bad..7189ce313cc22d600e84617fd7ebeffe609a7dad 100644 (file)
@@ -5,6 +5,9 @@
 #include "intproto.h"
 
 
+/**
+ * @file
+ */
 /* Queue management */
 /* Single linked circular lists with queue represented as pointer to rear */
 
index 49db7271214e157833bcef75b2d12575216d5dea..04873dbe53038c22a1b958205961b946f2c41673 100644 (file)
@@ -4,6 +4,9 @@
 #include "process.h"
 #include "intproto.h"
 
+/**
+ * @file
+ */
 
 #ifndef NO_PROTOTYPES
 static bool isenabled(word,word);
index 6ff0c812993f52bb2c98112277d4cef18ae70516..77d697802ff260f2277c772cface06a746ec20d1 100644 (file)
@@ -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.
  */
index e865220236019e84a605e5126958f2012324f5d2..f676d3686b0a545ebfa7d3185225faf4b5b61b6f 100644 (file)
@@ -37,9 +37,12 @@ or             Andrzej Salwicki
 #include <math.h>
 #include <time.h>
 
-/* 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;
index 2a70407da85e37de4e0181ce1d33d9e526f0a92b..fb9f498ccb2336be63dd87c75476067db68acc6d 100644 (file)
@@ -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)
index 96d68858edf5ba40a6badde659384eb13b07f200..898587ddc3713799f0d232620b79d425791f836d 100644 (file)
@@ -37,7 +37,10 @@ or             Andrzej Salwicki
 
 #include <time.h>
 
-/* 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)
 {
index 58cd99480a59f0d7ea8ff01119d8b08ba5712fbf..e55dd88cce58702ca27acb4dbccffe18c9d5b9fe 100644 (file)
@@ -6,6 +6,10 @@
 
 #include "ui/dialogs/ConnectDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 2e0f931219be60ec42fe853c06de8d04ae62b35d..53b821cf225687bb925f516c91ce6509d71b6410 100644 (file)
@@ -5,6 +5,10 @@
 
 #include "ui/dialogs/KillDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 7ddd6acc5ef5db66f9cd7dc8a9bc148202203dc8..d8c1cfc4fe3eb6205ee2a57069df0edb8b93bc92 100644 (file)
@@ -5,6 +5,10 @@
 
 #include "ui/dialogs/LockDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index cb9d149055f77963391906b114b94f3f97a7ad99..95ab8fc3d908150e83b9b3382441deb2f15fd5a4 100644 (file)
@@ -5,6 +5,10 @@
 
 #include "ui/dialogs/MessageDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 6459295432c2828322c37e278340760c41f8e40f..f55aabf2d3c4b3d36f42660953bc1e956e711026 100644 (file)
@@ -5,6 +5,10 @@
 
 #include "ui/dialogs/OptionsDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index aaef05d22609964027ed47122f8b7263984d17b1..fdb76061d33232aba19ed9ba6fcfc9725e66bb9c 100644 (file)
@@ -54,6 +54,9 @@
 #define WARN_COL       1
 #define NORM_COL       2
 
+/**
+ * @file
+ */
 
 namespace loglan {
 namespace vlp {
index 14e1bca13dca61b39e51ed734d11a157b6860a2a..9a758d4db6cc5c5e034ad726d698d5d532eb4460 100644 (file)
@@ -6,6 +6,10 @@
 
 #include "ui/dialogs/AddNodeDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index 9967ae3f0f32843826b5235bce669b4ec6f7811f..e75e632cbd3ca1d144e20932c5e563706c18fc4c 100644 (file)
@@ -9,6 +9,10 @@
 
 #include "ui/dialogs/NodeListDialog.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {
 namespace dialog {
index c19e0cf66cbc477f2c0f1ea25391f515d4481842..e303582b1ebed4979c9e5cef0c25b085c59f6a9e 100644 (file)
@@ -6,6 +6,10 @@
 
 #include "ui/VLPConfigWindow.h"
 
+/**
+ * @file
+ */
+
 namespace loglan {
 namespace vlp {