Document some fields.

This commit is contained in:
Bill Currie 2013-03-14 19:40:19 +09:00
parent 8032d1d4d1
commit 97da7fe31d

View file

@ -97,7 +97,7 @@ typedef struct cluster_s {
} cluster_t; } cluster_t;
typedef struct pstack_s { typedef struct pstack_s {
struct pstack_s *next; struct pstack_s *next; ///< linked list of active stack objects
cluster_t *cluster; cluster_t *cluster;
portal_t *portal; // portal exiting portal_t *portal; // portal exiting
winding_t *source, *pass; winding_t *source, *pass;
@ -107,21 +107,21 @@ typedef struct pstack_s {
} pstack_t; } pstack_t;
typedef struct { typedef struct {
int portaltest; int portaltest; ///< number of portals tested via separators
int portalpass; int portalpass; ///< number of portals through which vis passes
int portalcheck; int portalcheck; ///< number of portal checks
int chains; int chains; ///< number of visits to clusters
int mighttest; int mighttest; ///< amount mightsee is used for masked tests
int vistest; int vistest; ///< amount visbits is used for masked tests
int mightseeupdate; int mightseeupdate; ///< amount of updates to waiting portals
} visstat_t; } visstat_t;
typedef struct threaddata_s { typedef struct threaddata_s {
visstat_t stats; visstat_t stats; ///< per-thread statistics merged on completion
set_t *clustervis; set_t *clustervis; ///< clusters base portal can see
portal_t *base; portal_t *base; ///< portal for which this thread is being run
pstack_t pstack_head; pstack_t pstack_head;
sep_t *sep_freelist; sep_t *sep_freelist; ///< per-thread list of free separators
} threaddata_t; } threaddata_t;
extern int numportals; extern int numportals;