内容大更新

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

Doc/man/man3/STL_rStack.3

@@ -0,0 +1,284 @@
+.TH "STL_rStack" 3 "2022年 十一月 22日 星期二" "Version 2.0.0" "MF32BSP_XerolySkinner" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+STL_rStack \- 一个栈的类  
+
+.SH SYNOPSIS
+.br
+.PP
+.PP
+\fC#include <STL_Stack\&.h>\fP
+.SS "Public 成员函数"
+
+.in +1c
+.ti -1c
+.RI "\fBSTL_rStack\fP (void)"
+.br
+.ti -1c
+.RI "\fB~STL_rStack\fP (void)"
+.br
+.ti -1c
+.RI "\fBu8\fP \fBpush\fP (\fBu8\fP var)"
+.br
+.RI "压入一个成员 "
+.ti -1c
+.RI "\fBu8\fP \fBpop\fP (void)"
+.br
+.RI "弹出一个成员 "
+.ti -1c
+.RI "\fBu8\fP \fBtop\fP (\fBu8\fP &var)"
+.br
+.RI "显示最后压入的数值 "
+.ti -1c
+.RI "\fBu32\fP \fBThe_size\fP (void)"
+.br
+.RI "返回成员数量 "
+.ti -1c
+.RI "\fBu32\fP \fBThe_room\fP (void)"
+.br
+.RI "返回占用的内存数 "
+.ti -1c
+.RI "\fBu8\fP \fBclean\fP (void)"
+.br
+.RI "将申请的空间比对所需空间,腾出冗余空间 "
+.ti -1c
+.RI "\fBu8\fP \fBpoptop\fP (void)"
+.br
+.RI "弹出并且返回一个成员 "
+.ti -1c
+.RI "\fBu8\fP \fBpush32\fP (\fBu32\fP var)"
+.br
+.RI "压入一个32位成员 "
+.ti -1c
+.RI "\fBu32\fP \fBpoptop32\fP (void)"
+.br
+.RI "弹出并且返回一个32位成员 "
+.ti -1c
+.RI "void \fBpushfun\fP (void(*fun)(void))"
+.br
+.RI "压入一个void(*)void函数 "
+.in -1c
+.SS "Public 属性"
+
+.in +1c
+.ti -1c
+.RI "void(*)(void) \fBpoptopfun\fP (void)"
+.br
+.in -1c
+.SS "Private 属性"
+
+.in +1c
+.ti -1c
+.RI "\fBu32\fP \fBroom\fP"
+.br
+.ti -1c
+.RI "\fBu32\fP \fBsize\fP"
+.br
+.ti -1c
+.RI "\fBu8\fP * \fBdat\fP"
+.br
+.in -1c
+.SH "详细描述"
+.PP 
+一个栈的类 
+
+
+.PP
+\fB注解\fP
+.RS 4
+使用realloc重新分配方式组织 栈的内存空间的连续的,适合小数据常规速度交换数据 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.h\fP 第 \fB59\fP 行定义\&.
+.SH "构造及析构函数说明"
+.PP 
+.SS "STL_rStack::STL_rStack (void)"
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB41\fP 行定义\&.
+.SS "STL_rStack::~STL_rStack (void)"
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB46\fP 行定义\&.
+.SH "成员函数说明"
+.PP 
+.SS "\fBu8\fP STL_rStack::clean (void)"
+
+.PP
+将申请的空间比对所需空间,腾出冗余空间 
+.PP
+\fB返回\fP
+.RS 4
+错误号 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB125\fP 行定义\&.
+.SS "\fBu8\fP STL_rStack::pop (void)"
+
+.PP
+弹出一个成员 
+.PP
+\fB返回\fP
+.RS 4
+错误号 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB83\fP 行定义\&.
+.SS "\fBu8\fP STL_rStack::poptop (void)"
+
+.PP
+弹出并且返回一个成员 
+.PP
+\fB返回\fP
+.RS 4
+弹出的成员值 
+.RE
+.PP
+\fB注解\fP
+.RS 4
+该函数不会检查成功与否 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB164\fP 行定义\&.
+.SS "\fBu32\fP STL_rStack::poptop32 (void)"
+
+.PP
+弹出并且返回一个32位成员 
+.PP
+\fB返回\fP
+.RS 4
+弹出的成员值 
+.RE
+.PP
+\fB注解\fP
+.RS 4
+该函数不会检查成功与否 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB174\fP 行定义\&.
+.SS "\fBu8\fP STL_rStack::push (\fBu8\fP var)"
+
+.PP
+压入一个成员 
+.PP
+\fB参数\fP
+.RS 4
+\fIvar\fP 需要压入的数值 
+.RE
+.PP
+\fB返回\fP
+.RS 4
+错误号 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB56\fP 行定义\&.
+.SS "\fBu8\fP STL_rStack::push32 (\fBu32\fP var)"
+
+.PP
+压入一个32位成员 
+.PP
+\fB参数\fP
+.RS 4
+\fIvar\fP 需要压入的数值 
+.RE
+.PP
+\fB返回\fP
+.RS 4
+错误号 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB152\fP 行定义\&.
+.SS "void STL_rStack::pushfun (void(*)(void) fun)"
+
+.PP
+压入一个void(*)void函数 
+.PP
+\fB注解\fP
+.RS 4
+该函数不会检查成功与否 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB194\fP 行定义\&.
+.SS "\fBu32\fP STL_rStack::The_room (void)"
+
+.PP
+返回占用的内存数 
+.PP
+\fB返回\fP
+.RS 4
+内存数,u8类型 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB118\fP 行定义\&.
+.SS "\fBu32\fP STL_rStack::The_size (void)"
+
+.PP
+返回成员数量 
+.PP
+\fB返回\fP
+.RS 4
+成员数量,为u8类型,如u32将占4个元素 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB111\fP 行定义\&.
+.SS "\fBu8\fP STL_rStack::top (\fBu8\fP & var)"
+
+.PP
+显示最后压入的数值 
+.PP
+\fB参数\fP
+.RS 4
+\fI&var\fP 最后压入数值的储存变量 
+.RE
+.PP
+\fB返回\fP
+.RS 4
+错误号 
+.RE
+.PP
+
+.PP
+在文件 \fBSTL_Stack\&.cpp\fP 第 \fB101\fP 行定义\&.
+.SH "类成员变量说明"
+.PP 
+.SS "\fBu8\fP* STL_rStack::dat\fC [private]\fP"
+
+.PP
+在文件 \fBSTL_Stack\&.h\fP 第 \fB82\fP 行定义\&.
+.SS "void(*)(void) STL_rStack::poptopfun(void)"
+
+.PP
+在文件 \fBSTL_Stack\&.h\fP 第 \fB78\fP 行定义\&.
+.SS "\fBu32\fP STL_rStack::room\fC [private]\fP"
+
+.PP
+在文件 \fBSTL_Stack\&.h\fP 第 \fB80\fP 行定义\&.
+.SS "\fBu32\fP STL_rStack::size\fC [private]\fP"
+
+.PP
+在文件 \fBSTL_Stack\&.h\fP 第 \fB81\fP 行定义\&.
+
+.SH "作者"
+.PP 
+由 Doyxgen 通过分析 MF32BSP_XerolySkinner 的 源代码自动生成\&.