summaryrefslogtreecommitdiff
path: root/docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt
diff options
context:
space:
mode:
authorChris Wilson <chris+github@qwirx.com>2009-03-28 12:25:05 +0000
committerChris Wilson <chris+github@qwirx.com>2009-03-28 12:25:05 +0000
commit35e48b188329bf1048dfe154247b3259441de29f (patch)
tree289136939151abaae7447c94f684f134ea4b3381 /docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt
parent5ca3021ed632ff92d0d93d34ef2b75bdfd956d38 (diff)
Reorganise docs in trunk to match distribution layout, which is cleaner,
and makes Makefile work on distributions and trunk equally.
Diffstat (limited to 'docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt')
-rw-r--r--docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt b/docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt
new file mode 100644
index 00000000..0a5efbf7
--- /dev/null
+++ b/docs/api-notes/raidfile/lib_raidfile/RaidFileRead.txt
@@ -0,0 +1,14 @@
+CLASS RaidFileRead
+
+Read a raid file.
+
+IOStream interface, plus a few extras, including reading directories and checking that files exist.
+
+
+FUNCTION RaidFileRead::Open
+
+Open a given raid file -- returns a pointer to a new RaidFileRead object.
+
+Note that one of two types could be returned, depending on the representation of the file.
+
+