内容大更新

更加规范化
加入modbus类
优化帮助文档

Doc/man/man3/bsp_ModBus_Rx.3

@@ -0,0 +1,156 @@
+.TH "bsp_ModBus_Rx" 3 "2022年 十一月 22日 星期二" "Version 2.0.0" "MF32BSP_XerolySkinner" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+bsp_ModBus_Rx \- ModBus协议分析器  
+
+.SH SYNOPSIS
+.br
+.PP
+.PP
+\fC#include <bsp_ModBus\&.h>\fP
+.SS "Public 成员函数"
+
+.in +1c
+.ti -1c
+.RI "\fBbsp_ModBus_Rx\fP (void)"
+.br
+.ti -1c
+.RI "\fB~bsp_ModBus_Rx\fP (void)"
+.br
+.ti -1c
+.RI "void \fBanalysis\fP (\fBu8\fP *dat)"
+.br
+.RI "以ModBus协议分析缓冲区内数据 "
+.in -1c
+.SS "Public 属性"
+
+.in +1c
+.ti -1c
+.RI "\fBu8\fP \fBID\fP"
+.br
+.RI "器件ID "
+.ti -1c
+.RI "\fBu8\fP \fBFunc\fP"
+.br
+.RI "功能号 "
+.ti -1c
+.RI "\fBu8\fP \fBcrcts\fP"
+.br
+.RI "CRC测试 "
+.ti -1c
+.RI "\fBu16\fP * \fBKeepRegDat\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP \fBKeepRegMem\fP"
+.br
+.ti -1c
+.RI "\fBu16\fP * \fBInRegDat\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP \fBInRegMem\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP * \fBOutCoilDat\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP \fBOutCoilMem\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP * \fBInCoilDat\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP \fBInCoilMem\fP"
+.br
+.in -1c
+.SH "详细描述"
+.PP 
+ModBus协议分析器 
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB82\fP 行定义\&.
+.SH "构造及析构函数说明"
+.PP 
+.SS "bsp_ModBus_Rx::bsp_ModBus_Rx (void)"
+
+.PP
+在文件 \fBbsp_ModBus\&.cpp\fP 第 \fB365\fP 行定义\&.
+.SS "bsp_ModBus_Rx::~bsp_ModBus_Rx (void)"
+
+.PP
+在文件 \fBbsp_ModBus\&.cpp\fP 第 \fB371\fP 行定义\&.
+.SH "成员函数说明"
+.PP 
+.SS "void bsp_ModBus_Rx::analysis (\fBu8\fP * dat)"
+
+.PP
+以ModBus协议分析缓冲区内数据 
+.PP
+\fB参数\fP
+.RS 4
+\fI*dat\fP 待分析的缓冲区 
+.RE
+.PP
+\fB返回\fP
+.RS 4
+无返回值 
+.RE
+.PP
+
+.PP
+在文件 \fBbsp_ModBus\&.cpp\fP 第 \fB304\fP 行定义\&.
+.SH "类成员变量说明"
+.PP 
+.SS "\fBu8\fP bsp_ModBus_Rx::crcts"
+
+.PP
+CRC测试 
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB91\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::Func"
+
+.PP
+功能号 
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB90\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::ID"
+
+.PP
+器件ID 
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB89\fP 行定义\&.
+.SS "\fBu8\fP* bsp_ModBus_Rx::InCoilDat"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB102\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::InCoilMem"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB103\fP 行定义\&.
+.SS "\fBu16\fP* bsp_ModBus_Rx::InRegDat"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB96\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::InRegMem"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB97\fP 行定义\&.
+.SS "\fBu16\fP* bsp_ModBus_Rx::KeepRegDat"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB93\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::KeepRegMem"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB94\fP 行定义\&.
+.SS "\fBu8\fP* bsp_ModBus_Rx::OutCoilDat"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB99\fP 行定义\&.
+.SS "\fBu8\fP bsp_ModBus_Rx::OutCoilMem"
+
+.PP
+在文件 \fBbsp_ModBus\&.h\fP 第 \fB100\fP 行定义\&.
+
+.SH "作者"
+.PP 
+由 Doyxgen 通过分析 MF32BSP_XerolySkinner 的 源代码自动生成\&.