API 文档补充至 ege 20.08 版本，修复部分错误 (#140)

docs: 文档更新至 20.08 版本 * 增加 CSS 样式 * API 文档更新至 ege 20.08 版本 * 文档中添加 API 版本要求列 * 增加部分缺失的函数文档, 部分文档内容修改 * 文档主页内容更新和排版调整 * 增加 ege19.01 和 ege 20.08 版本的更新日志，排版改为表格形式 * 将 man/readme 的部分内容改为用表格展示
wysaid · Jan 22, 2024 · 4fbea4c · 4fbea4c
1 parent f813b5e
commit 4fbea4c
Show file tree

Hide file tree

Showing 211 changed files with 4,458 additions and 2,911 deletions.
diff --git a/man/about/index.htm b/man/about/index.htm
diff --git a/man/api/col/EGEACOLOR.htm b/man/api/col/EGEACOLOR.htm
@@ -1,31 +1,36 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEACOLOR</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEACOLOR</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEACOLOR</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEACOLOR 宏用于通过透明度和RGB颜色合成ARGB颜色。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
+EGEACOLOR 宏用于将透明度和 RGB 颜色合成 ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
 <pre><font color=#800080>color_t EGEACOLOR</font>(
-    <font color=#800080>BYTE </font>byAlpha,   <font color=#008000>// 颜色的透明度</font>
-    <font color=#800080>color_t </font>rgbColor     <font color=#008000>// 颜色的红色部分</font>
-    );
+    <font color=#800080>BYTE </font>alpha,<font color=#008000>       // 透明度</font>
+    <font color=#800080>color_t </font>rgbColor<font color=#008000>  // RGB 颜色</font>
+);
 </pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
+
+alpha
+颜色的透明度，取值范围：0 到 255，数值越小越透明。0 表示完全透明，255 表示不透明。
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-byAlpha
-颜色的透明度，取值范围：0~255，0表示完全透明，255表示不透明。
 rgbColor
-RGB颜色值。
+RGB 颜色值。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+合成的 ARGB 颜色。
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-返回合成的ARGB颜色。
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEAGRAY.htm b/man/api/col/EGEAGRAY.htm
@@ -1,32 +1,37 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEAGRAY</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEAGRAY</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEAGRAY</font>
 
 <font size ="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEAGRAY 宏用于通过透明度和灰度值生成对应的ARGB颜色。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
+EGEAGRAY 宏用于将透明度和灰度值合成对应的ARGB颜色。
+
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
 <pre><font color=#800080>color_t EGEAGRAY</font>(
-    <font color=#800080>BYTE </font>byAlpha,    <font color=#008000>// 颜色的透明度</font>
-    <font color=#800080>BYTE </font>byGray      <font color=#008000>// 颜色的灰度值</font>   
-    );
+    <font color=#800080>BYTE </font>alpha,<font color=#008000>  // 透明度</font>
+    <font color=#800080>BYTE </font>gray<font color=#008000>    // 灰度值</font>   
+);
 </pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
+
+alpha
+颜色的透明度，取值范围：0 到 255，0表示完全透明，255表示不透明。
+
+gray
+颜色的灰度值，取值范围：0 到 255。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-byAlpha
-颜色的透明度，取值范围：0~255，0表示完全透明，255表示不透明。
-byGray
-颜色的灰度值，取值范围：0~255。
+合成的ARGB灰色。
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-返回合成的ARGB灰色。
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEARGB.htm b/man/api/col/EGEARGB.htm
@@ -1,37 +1,44 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEARGB</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEARGB</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEARGB</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEARGB 宏用于通过透明度和红、绿、蓝颜色分量合成颜色。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
+EGEARGB 宏用于将透明度和红、绿、蓝颜色分量合成 ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
 <pre><font color=#800080>color_t EGERGBA</font>(
-    <font color=#800080>BYTE </font>byAlpha,   <font color=#008000>// 颜色的透明度</font>
-    <font color=#800080>BYTE </font>byRed,     <font color=#008000>// 颜色的红色部分</font>
-    <font color=#800080>BYTE </font>byGreen,   <font color=#008000>// 颜色的绿色部分</font>
-    <font color=#800080>BYTE </font>byBlue     <font color=#008000>// 颜色的蓝色部分</font>   
-    );
+    <font color=#800080>BYTE </font>alpha,<font color=#008000>  // 透明度</font>
+    <font color=#800080>BYTE </font>red,<font color=#008000>    // 红色分量</font>
+    <font color=#800080>BYTE </font>green,<font color=#008000>  // 绿色分量</font>
+    <font color=#800080>BYTE </font>blue<font color=#008000>    // 蓝色分量</font>   
+);
 </pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
+
+alpha
+颜色的透明度，取值范围：0 到 255，0表示完全透明，255表示不透明。
+
+red
+红色分量，取值范围：0 到 255。
+
+green
+绿色分量，取值范围：0 到 255。
+
+blue
+蓝色分量，取值范围：0 到 255。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-byAlpha
-颜色的透明度，取值范围：0~255，0表示完全透明，255表示不透明。
-byRed
-颜色的红色部分，取值范围：0~255。
-byGreen
-颜色的绿色部分，取值范围：0~255。
-byBlue
-颜色的蓝色部分，取值范围：0~255。
+合成的 ARGB 颜色。
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-返回合成的颜色。
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGECOLORA.htm b/man/api/col/EGECOLORA.htm
@@ -1,31 +1,36 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGECOLORA</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGECOLORA</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGECOLORA</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGECOLORA 宏用于通过RGB颜色和透明度合成ARGB颜色。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
+EGECOLORA 宏用于将 RGB 颜色和透明度合成 ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
 <pre><font color=#800080>color_t EGECOLORA</font>(
-    <font color=#800080>color_t </font>rgbColor,<font color=#008000>    // RGB颜色</font>
-    <font color=#800080>BYTE </font>byAlpha   <font color=#008000>      // 颜色的透明度</font>
+    <font color=#800080>color_t </font>rgbColor,<font color=#008000>    // RGB 颜色</font>
+    <font color=#800080>BYTE </font>alpha<font color=#008000>           // 透明度</font>
 );
 </pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
 rgbColor
-RGB颜色值。
-byAlpha
-颜色的透明度，取值范围：0~255，0表示完全透明，255表示不透明。
+RGB 颜色值。
+
+alpha
+颜色的透明度，取值范围：0 到 255，0 表示完全透明，255 表示不透明。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+合成的 ARGB 颜色。
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-返回合成的ARGB颜色。
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEGET_A.htm b/man/api/col/EGEGET_A.htm
@@ -1,25 +1,29 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEGET_A</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEGET_A</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEGET_A</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEGET_A 宏用于返回指定颜色中的透明度。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
-<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_A</font>(<font color=#800080>color_t </font>rgb);</pre>
+获取 ARGB 颜色中的透明度 alpha。
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-rgb
-指定的颜色。
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
+<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_A</font>(<font color=#800080>color_t </font>color);</pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-指定颜色中的透明度，值的范围 0~255。
+color
+ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+ARGB 颜色中的透明度，值的范围 0 到 255。
+
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEGET_B.htm b/man/api/col/EGEGET_B.htm
@@ -1,25 +1,29 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEGET_B</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEGET_B</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEGET_B</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEGET_B 宏用于返回指定颜色中的蓝色值。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
-<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_B</font>(<font color=#800080>color_t </font>rgb);</pre>
+获取 ARGB 颜色中的蓝色分量。
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-rgb
-指定的颜色。
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
+<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_B</font>(<font color=#800080>color_t </font>color);</pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-指定颜色中的蓝色值，值的范围 0~255。
+color
+ARGB 颜色
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+ARGB 颜色中的蓝色分量，值的范围 0 到 255。
+
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEGET_G.htm b/man/api/col/EGEGET_G.htm
@@ -1,25 +1,29 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEGET_G</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEGET_G</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEGET_G</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEGET_G 宏用于返回指定颜色中的绿色值。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
-<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_G</font>(<font color=#800080>color_t </font>rgb);</pre>
+获取 ARGB 颜色中的绿色分量。
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-rgb
-指定的颜色。
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
+<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_G</font>(<font color=#800080>color_t </font>color);</pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-指定颜色中的绿色值，值的范围 0~255。
+color
+ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+ARGB 颜色中的绿色分量，值的范围 0 到 255。
+
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>

diff --git a/man/api/col/EGEGET_R.htm b/man/api/col/EGEGET_R.htm
@@ -1,25 +1,29 @@
 <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <title>EGEGET_R</title>
+    <link rel="stylesheet" type="text/css" href="../../css/index-table.css"/>
 </head>
 <body>
 
-<pre><font size="4"><a href="../../index.htm">主页</a>-＞<a href="../index.htm">库函数目录</a>-＞<a href="index.htm">颜色表示及相关函数</a>-＞EGEGET_R</font>
+<pre><font size="4"><a href="../../index.htm">主页</a> / <a href="../index.htm">库函数目录</a> / <a href="index.htm">颜色</a> / EGEGET_R</font>
 <font size="4">
-<font size="5" color="#0000FF"><strong>功能：</strong></font>
-EGEGET_R 宏用于返回指定颜色中的红色值。
+<font size="4" color="#0000FF"><strong>功能：</strong></font>
 
-<font size="5" color="#0000FF"><strong>声明：</strong></font>
-<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_R</font>(<font color=#800080>color_t </font>rgb);</pre>
+获取 ARGB 颜色中的红色分量。
 
-<font size="5" color="#0000FF"><strong>参数：</strong></font>
-rgb
-指定的颜色。
+<font size="4" color="#0000FF"><strong>声明：</strong></font>
+<pre><font color=#800080>color_t </font><font color=#008080>EGEGET_R</font>(<font color=#800080>color_t </font>color);</pre>
+<font size="4" color="#0000FF"><strong>参数：</strong></font>
 
-<font size="5" color="#0000FF"><strong>返回值：</strong></font>
-指定颜色中的红色值，值的范围 0~255。
+color
+ARGB 颜色。
+
+<font size="4" color="#0000FF"><strong>返回值：</strong></font>
+
+ARGB 颜色中的红色分量，值的范围 0 到 255。
+
+<font size="4" color="#0000FF"><strong>示例：</strong></font>
 
-<font size="5" color="#0000FF"><strong>示例：</strong></font>
 （无）
 </font>
 </pre>