add comments (documentation) for class SharedMemory.

docs/UniSetDox.cfg.in

@@ -20,7 +20,7 @@
 # iconv built into libc) for the transcoding. See 
 # http://www.gnu.org/software/libiconv for the list of possible encodings.
 
-DOXYFILE_ENCODING      = UTF-8
+DOXYFILE_ENCODING      = KOI8-R
 
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
@@ -525,7 +525,7 @@ INPUT                  = DocPages/ \
 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
 # the list of possible encodings.
 
-INPUT_ENCODING         = UTF-8
+INPUT_ENCODING         = KOI8-R
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

docs/UniSetDoxDevel.cfg.in

@@ -20,7 +20,7 @@
 # iconv built into libc) for the transcoding. See 
 # http://www.gnu.org/software/libiconv for the list of possible encodings.
 
-DOXYFILE_ENCODING      = UTF-8
+DOXYFILE_ENCODING      = KOI8-R
 
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
@@ -525,7 +525,7 @@ INPUT                  = ../include/ \
 # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
 # the list of possible encodings.
 
-INPUT_ENCODING         = UTF-8
+INPUT_ENCODING         = KOI8-R
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

extensions/SharedMemory/SharedMemory.h

@@ -12,12 +12,182 @@
 #include "WDTInterface.h"
 // -----------------------------------------------------------------------------
 
-/*!      
+/*! \page page_SharedMemory      
+
+
+      \section sec_SM_Common    SharedMemory
+
 	:
-	- 
-	-    (  ),
+	- \ref sec_SM_Save 
+	- \ref sec_SM_Conf
+	- \ref sec_SM_Event
+	- \ref sec_SM_HeartBeat
+	- \ref sec_SM_History
+	- \ref sec_SM_Pulsar
+	- \ref sec_SM_DBLog
+
+	\section sec_SM_Save 
+	
+	\section sec_SM_Conf    
+	  SM    ,  SM  
+	     .      
+	    ""(consumer)   ,  
+	      (depends)  .
+	        
+
+	 \par    
+	  \code
+	    --s-filter-field   -     
+	    --s-filter-value   -    .  .
+	  \endcode
+	  :
+	\code
+	  <sensors>
+	    ...
+	    <item id="12" name="Sensor12" textname="xxx" .... myfilter="m1" ...>
+	      <consumers>
+		    <item name="Consumer1" type="object" mycfilter="c1" .../>
+	      </consumers>
+	    </item>  
+	    ...
+	    <item id="121" name="Sensor121" textname="xxx" .... myfilter="m1" ...>
+	      <consumers>
+		    <item name="Consumer1" type="object" mycfilter="c1" .../>
+	      </consumers>
+	    </item>  
+	    ...
+	  </sensors>
+	\endcode
+	 ,  SM     12  121 
+	 \b --s-filter-field myfilter \b --s-filter-value m1.
+	
+	\par   (consumer)
+	  \code
+	    ---filter-field   -      (consumer)
+	    ---filter-value   -    .  .
+	  \endcode
+	  \b --c-filter-field mycfilter \b --c-filter-value c1,   
+	SM ӣ   ,   ,     
+	\a mycfilter="c1".
+	
+	\par   (depends)
+	  \code
+	    --d-filter-field   -     "" (depends)
+	    --d-filter-value   -    .  .
+	  \endcode
+	...  ...       ...
+	
+		
+	\note   \b --X-filter-value      (,)
+	   \b --X-filter-field  .
+	\note     \b --X-filter-field -   SM     
+	(, )   <sensors>.
+	
+	
+	\section sec_SM_Event    SM
+	 SM      ,
+	    / SM.
+	  ,     
+	    \b --e-filter. 
+	 \b --e-startup-pause msec -     SM,
+	     .
+	      ,
+	        
+	\b evnt_xxx="1",  \b xxx -      
+	\b --e-filter.
+	:
+	\code
+	<objects>
+	  ...
+	  <item id="2342" name="MyObject" ... evnt_myfilter="1" ../>
+	</objects>
+	\endcode
+	     SM    \b --e-filter myfilter.
+	  ϣ  SM ̣    2342 .
+	
+	      \b SystemMessage::WatchDog.
+
+		
+	\section sec_SM_HeartBeat   "" 
+	
+	      (  ),
 	       "" .
-	-    
+	  ...
+	  ...
+	  
+
+	\section sec_SM_History   
+	" "      
+	(       . ),
+	       .
+	  ""    (
+	  ,   )    
+	  "".     ( "")
+	 ,      
+	  SharedMemory::signal_history().   
+	 , ,       ģ ""
+	  .
+	     . .  
+	    SharedMemory    
+	"<History>".
+	:
+	     "".
+       \code
+	<SharedMemory name="SharedMemory" shmID="SharedMemory">
+		<History savetime="200">
+			<item id="1" fuse_id="AlarmFuse1_S" fuse_invert="1" size="30" filter="a1"/>
+			<item id="2" fuse_id="AlarmFuse2_AS" fuse_value="2" size="30" filter="a2"/>
+		</History>
+	</SharedMemory>	
+       \endcode
+       :
+       \code
+       savetime     -     ,  .
+       id           -  ()  ""
+       fuse_id      -   ""
+       fuse_value   -   (  "")
+       fuse_invert  -  (  ""). 
+                      ..    "0".
+       
+       size         -     
+       filter       -     ,  
+                         . 
+	\endcode 
+       
+              .
+       
+           :
+       
+             <History>
+           .   
+          <sensors>    " "   
+          (\b filter),     .
+       
+         \b savetime      .
+              ()  ,
+          ,       
+       \b size .
+       
+              (saveXXX, setXXX) 
+         "".     
+       ""   ,     
+          .
+       
+       \section sec_SM_Pulsar ""  
+        SM        (""),
+             ϣ .  
+            \b pulsar_id    ,
+        \b --pulsar-id.     \b pulsar_msec
+           \b --pulsar-msec.     
+           DO  DI.     
+       \b pulsar_iotype     \b --pulsar-iotype.
+       
+       \section sec_SM_DBLog      
+        ,    SM       
+       (    IONotifyController).
+          \b --db-logging 1    
+       (      ).
+   
 */
 class SharedMemory:
 	public IONotifyController_LT
@@ -85,7 +255,7 @@ class SharedMemory:
 		typedef std::list<HistoryInfo> History;
 
 		typedef sigc::signal<void,HistoryInfo*> HistorySlot;
-		HistorySlot signal_history();
+		HistorySlot signal_history(); /*!<     ""   */
 		
 	protected:
 		typedef std::list<Restorer_XML::ReaderSlot> ReadSlotList;