From 96ea4eba63766210e5de12274bce6a697b2cfe70 Mon Sep 17 00:00:00 2001
From: Matthew Flatt <mflatt@racket-lang.org>
Date: Thu, 15 Nov 2007 18:19:57 +0000
Subject: [PATCH] add a few comments to scribble-index

svn: r7740

original commit: 79237377439ae2856047f16bccc23da7222e3940
---
 collects/setup/scribble-index.ss | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/collects/setup/scribble-index.ss b/collects/setup/scribble-index.ss
index c635a6bb..828b18ee 100644
--- a/collects/setup/scribble-index.ss
+++ b/collects/setup/scribble-index.ss
@@ -17,7 +17,12 @@
          xref-index
          (struct-out entry))
 
-(define-struct entry (words content link-key desc))
+(define-struct entry (words    ; list of strings: main term, sub-term, etc.
+                      content  ; Scribble content to the index label
+                      link-key ; for generating a Scribble link
+                      desc))   ; further info that depends on the kind of index entry
+
+;; Private:
 (define-struct xrefs (renderer ri))
 
 ;; ----------------------------------------