summaryrefslogtreecommitdiff
path: root/docs/manual/developer/documenting.html.zh-cn
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual/developer/documenting.html.zh-cn')
-rw-r--r--docs/manual/developer/documenting.html.zh-cn82
1 files changed, 82 insertions, 0 deletions
diff --git a/docs/manual/developer/documenting.html.zh-cn b/docs/manual/developer/documenting.html.zh-cn
new file mode 100644
index 00000000..72f496c3
--- /dev/null
+++ b/docs/manual/developer/documenting.html.zh-cn
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="zh-cn" xml:lang="zh-cn"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>Apache 2.0 文档 - Apache HTTP 服务器</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page" class="no-sidebar"><div id="page-header">
+<p class="menu"><a href="../mod/">模块</a> | <a href="../mod/directives.html">指令</a> | <a href="../faq/">常见问题</a> | <a href="../glossary.html">术语</a> | <a href="../sitemap.html">网站导航</a></p>
+<p class="apache">Apache HTTP 服务器版本 2.2</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP 服务器</a> &gt; <a href="http://httpd.apache.org/docs/">文档</a> &gt; <a href="../">版本 2.2</a> &gt; <a href="./">开发者文档</a></div><div id="page-content"><div id="preamble"><h1>Apache 2.0 文档</h1>
+<div class="toplang">
+<p><span>可用语言: </span><a href="../en/developer/documenting.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
+<a href="../zh-cn/developer/documenting.html" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
+</div>
+
+ <p>Apache 2.0 使用 <a href="http://www.doxygen.org/">Doxygen</a> 从代码中
+ 生成 API 和全局变量的文档。下面是对使用 Doxygen 生成文档的简介。</p>
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="brief" id="brief">简要说明</a></h2>
+ <p>使用 <code>/**</code> 开始文档块<br />
+ 使用 <code>*/</code> 结束文档块</p>
+
+ <p>在文档块中,我们可以使用多个标签:</p>
+
+ <div class="example"><p><code>
+ Description of this functions purpose<br />
+ @param parameter_name description<br />
+ @return description<br />
+ @deffunc signature of the function<br />
+ </code></p></div>
+
+ <p>一般不需要 <code>deffunc</code> 。DoxyGen 没有完整的解析器,所以任何
+ 在返回类型声明中使用宏的原型,都是太复杂了。这些函数就需要使用 <code>deffunc</code>。
+ 例如 (使用 &amp;gt; 而不是 &gt;):</p>
+
+ <div class="example"><p><code>
+ /**<br />
+ &nbsp;* return the final element of the pathname<br />
+ &nbsp;* @param pathname The path to get the final element of<br />
+ &nbsp;* @return the final element of the path<br />
+ &nbsp;* @tip Examples:<br />
+ &nbsp;* &lt;pre&gt;<br />
+ &nbsp;* "/foo/bar/gum" -&amp;gt; "gum"<br />
+ &nbsp;* "/foo/bar/gum/" -&amp;gt; ""<br />
+ &nbsp;* "gum" -&amp;gt; "gum"<br />
+ &nbsp;* "wi\\n32\\stuff" -&amp;gt; "stuff"<br />
+ &nbsp;* &lt;/pre&gt;<br />
+ &nbsp;* @deffunc const char * ap_filename_of_pathname(const char *pathname)<br />
+ &nbsp;*/
+ </code></p></div>
+
+ <p>总是在头文件开始包含:</p>
+ <div class="example"><p><code>
+ /**<br />
+ &nbsp;* @package Name of library header<br />
+ &nbsp;*/
+ </code></p></div>
+
+ <p>Doxygen 为每个包生成一个新的 HTML 文件,名字是
+ {Name_of_library_header}.html,所以请简化名称。</p>
+
+ <p>更深入的讨论,请参见
+ <a href="http://www.doxygen.org/">Doxygen 站点</a>。</p>
+</div></div>
+<div class="bottomlang">
+<p><span>可用语言: </span><a href="../en/developer/documenting.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
+<a href="../zh-cn/developer/documenting.html" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2011 The Apache Software Foundation.<br />基于 <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> 许可证.</p>
+<p class="menu"><a href="../mod/">模块</a> | <a href="../mod/directives.html">指令</a> | <a href="../faq/">常见问题</a> | <a href="../glossary.html">术语</a> | <a href="../sitemap.html">网站导航</a></p></div>
+</body></html> \ No newline at end of file