From 6860a39880e2a902f06e6221139e03eab5cde780 Mon Sep 17 00:00:00 2001
From: Karl Palsson <karlp@tweak.net.au>
Date: 周二, 28 1月 2014 08:29:55 +0800
Subject: [PATCH] Update documentation to reflect reality
---
README.md | 24 ++++++++++++------------
1 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index c8f2217..d5af5ba 100644
--- a/README.md
+++ b/README.md
@@ -41,14 +41,14 @@
Source codes are divided into a few files to provide better portability to other systems.
-- *libscpi/parser.c* - provides the core parser library
-- *libscpi/error.c* - provides basic error handling (error queue of the instrument)
-- *libscpi/ieee488.c* - provides basic implementation of IEEE488.2 mandatory commands
-- *libscpi/minimal.c* - provides basic implementation of SCPI mandatory commands
-- *libscpi/utils.c* - provides string handling routines and conversion routines
-- *libscpi/units.c* - provides handling of special numners (DEF, MIN, MAX, ...) and units
-- *libscpi/fifo.c* - provides basic implementation of error queue FIFO
-- *libscpi/debug.c* - provides debug functions
+- *libscpi/src/parser.c* - provides the core parser library
+- *libscpi/src/error.c* - provides basic error handling (error queue of the instrument)
+- *libscpi/src/ieee488.c* - provides basic implementation of IEEE488.2 mandatory commands
+- *libscpi/src/minimal.c* - provides basic implementation of SCPI mandatory commands
+- *libscpi/src/utils.c* - provides string handling routines and conversion routines
+- *libscpi/src/units.c* - provides handling of special numners (DEF, MIN, MAX, ...) and units
+- *libscpi/src/fifo.c* - provides basic implementation of error queue FIFO
+- *libscpi/src/debug.c* - provides debug functions
- *examples/test-parser* - is the basic non-interactive demo of the parser
- *examples/test-interactive* - is the basic interactive demo of the parser
@@ -75,9 +75,9 @@
scpi_interface_t scpi_interface = {
.write = myWrite,
.error = NULL,
- .reset = NULL,
- .test = NULL,
- .srq = NULL,
+ .reset = NULL, /* Called from SCPI_CoreRst */
+ .test = NULL, /* Called from SCPI_CoreTstQ */
+ .control = NULL,
};
```
@@ -116,7 +116,7 @@
A test implementation of function myWrite, which outputs everything to stdout, could be
```c
-size_t myWrite(scpi_context_t * context, const char * data, size_t len) {
+size_t myWrite(scpi_t * context, const char * data, size_t len) {
(void) context;
return fwrite(data, 1, len, stdout);
}
--
Gitblit v1.9.1