Jelajahi Sumber

updated documentation for upcoming release

Alois Zoitl 14 tahun lalu
induk
melakukan
ad816a496a
3 mengubah file dengan 5 tambahan dan 18 penghapusan
  1. 5 2
      README
  2. 0 10
      TODO
  3. 0 6
      src/ports/platform-pc/opener_user_conf.h

+ 5 - 2
README

@@ -51,8 +51,11 @@ Directory structure:
 
 
 Documentation:
 Documentation:
 ==============
 ==============
-The documentation of the functions of OpENer is part of the source code. You 
-will need the program Doxygen for generating the HTML documentation.
+The documentation of the functions of OpENer is part of the source code. The source 
+packages contain the generated documentation in the directory doc/api_doc. If you 
+use the SVN version you will need the program Doxygen for generating the HTML 
+documentation. You can generate the documentation by invoking doxygen from the 
+command line in the opener main directory.
 
 
 Porting OpENer:
 Porting OpENer:
 ===============
 ===============

+ 0 - 10
TODO

@@ -1,17 +1,12 @@
 This file serves as brainstorming buffer for ideas to improve and enhance OpENer:
 This file serves as brainstorming buffer for ideas to improve and enhance OpENer:
 
 
 * New Features:
 * New Features:
-  - Call-back interface to inform application on connection time outs
-     Establishment (acknowledge for listen only), Timeout, Close
-  - Change of State and application triggered connections
   - Implementation of common CIP-objects
   - Implementation of common CIP-objects
   - CIP-Sync
   - CIP-Sync
   - CIP-Motion
   - CIP-Motion
 
 
 
 
 * Improvements and Optimizations
 * Improvements and Optimizations
-  - Rework data serialization for the GetAttribute services
-  - Test exclusive owner connections (inputs/outputs)
   - Remove the need for the response buffer in the explicit message handling 
   - Remove the need for the response buffer in the explicit message handling 
   	(zero copy stack)
   	(zero copy stack)
   - Rework I/O message handling:
   - Rework I/O message handling:
@@ -23,8 +18,3 @@ This file serves as brainstorming buffer for ideas to improve and enhance OpENer
            the scanner gives a different port number
            the scanner gives a different port number
      - use the registered port number 2222 for all I/O communication 
      - use the registered port number 2222 for all I/O communication 
      
      
-     
-* Documentation
-  - Write general documentation section: 
-      - Using OpENer in Products
-      - Extending OpENer	       

+ 0 - 6
src/ports/platform-pc/opener_user_conf.h

@@ -164,10 +164,4 @@ typedef unsigned short in_port_t;
  */
  */
 #define OPENER_SUPPORT_64BIT_DATATYPES 1
 #define OPENER_SUPPORT_64BIT_DATATYPES 1
 
 
-/* TODO think if this is helpfull */
-/*! If this define is here opener will enable support for application triggered
- * connections.
- */
-#define OPENER_SUPPORT_APLICATION_TRIGGERED_CONNECTIONS 1
-
 #endif /*OPENER_USER_CONF_H_*/
 #endif /*OPENER_USER_CONF_H_*/