我应该使用什么文档工具来处理这个问题?
What documentation tool am I expected to process this with?
我有一个随 atmel 库 (at91lib
) 分发的文件,如下所示:
/**
\page "AT91 USB device framework"
AT91 USB %device framework is a device-side USB framework. It enables rapid
development of USB-compliant class drivers such as the Mass Storage Device
(MSD) or the Communication Device Class (CDC) and etc.
This page shows the index to describe the AT91 USB %device framework.
- USBD: USB Device
-# "USB Device Framework Architecture"
-# "USB Device Framework Description"
-# "Standard USB Structures"
-# "USBD API"
[etc]
*/
/**
\page "USB Device Framework Architecture"
!!!Framework Architecture
The following three-tiered structure is used:
- A #hardware layer# which performs low-level operations on the USB controller.
- The #USB API# offers hardware-independent methods and structures.
- The #application layer#, made up of a USB class driver and the user
application.
*/
显然,这是用于记录目录的某种文档注释系统。它还清楚地产生 HTML 输出,因为文件在某些时候包含 HTML 图像映射。
但是,!!!
看起来不像 doxygen,#
也不像链接。任何人都可以确定将此处理为 HTML 所需的文档工具吗?
DoxyS
如果你去 rendered version of the documentation 并检查 HTML 源代码(右键单击 -> 查看页面源代码),你会看到几个 linked Javascript HTML.
顶部附近的文件
<HTML>
<HEAD>
<TITLE>../../public_html/softpack-1.5/at91sam7x-ek - at91lib</TITLE>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
文件 ../../common/js.js
本身包含以下内容:
function Body5()
{
document.write("</div>\n");
document.write("</TD><TD class=\"sideIndent\"><img src=\"");
document.write(relPathToCommmon);
document.write("dot.gif\" class=\"sideIndent\"></TD></TR></table>\n");
document.write("</div>\n");
document.write("<div class=\"doxygenFooter\">\n");
document.write("<table cellspacing=0 cellpadding=0 border=0 class=\"width\"><TR><TD align=right>\n");
document.write("<a href=\"http://www.doxys.dk\" class=\"generatedDoxygen\" onmouseover=\"overLibGeneratedByDoxyS();return overlib('Generated by DoxyS 0.97<br>Wed Apr 16 16:50 2008');\" onmouseout=\"return nd();\">Generated by DoxyS</A>\n");
document.write("</TD><TD class=\"sideIndent\"><img src=\"");
document.write(relPathToCommmon);
document.write("dot.gif\" class=\"sideIndent\"></TD></TR></table>\n");
document.write("</div>\n");
document.write("</td></tr>\n");
document.write("</table>\n");
}
特别注意 link http://www.doxys.dk
和字符串 Generated by DoxyS 0.97<br>Wed Apr 16 16:50 2008
.
我有一个随 atmel 库 (at91lib
) 分发的文件,如下所示:
/**
\page "AT91 USB device framework"
AT91 USB %device framework is a device-side USB framework. It enables rapid
development of USB-compliant class drivers such as the Mass Storage Device
(MSD) or the Communication Device Class (CDC) and etc.
This page shows the index to describe the AT91 USB %device framework.
- USBD: USB Device
-# "USB Device Framework Architecture"
-# "USB Device Framework Description"
-# "Standard USB Structures"
-# "USBD API"
[etc]
*/
/**
\page "USB Device Framework Architecture"
!!!Framework Architecture
The following three-tiered structure is used:
- A #hardware layer# which performs low-level operations on the USB controller.
- The #USB API# offers hardware-independent methods and structures.
- The #application layer#, made up of a USB class driver and the user
application.
*/
显然,这是用于记录目录的某种文档注释系统。它还清楚地产生 HTML 输出,因为文件在某些时候包含 HTML 图像映射。
但是,!!!
看起来不像 doxygen,#
也不像链接。任何人都可以确定将此处理为 HTML 所需的文档工具吗?
DoxyS
如果你去 rendered version of the documentation 并检查 HTML 源代码(右键单击 -> 查看页面源代码),你会看到几个 linked Javascript HTML.
顶部附近的文件<HTML>
<HEAD>
<TITLE>../../public_html/softpack-1.5/at91sam7x-ek - at91lib</TITLE>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
文件 ../../common/js.js
本身包含以下内容:
function Body5()
{
document.write("</div>\n");
document.write("</TD><TD class=\"sideIndent\"><img src=\"");
document.write(relPathToCommmon);
document.write("dot.gif\" class=\"sideIndent\"></TD></TR></table>\n");
document.write("</div>\n");
document.write("<div class=\"doxygenFooter\">\n");
document.write("<table cellspacing=0 cellpadding=0 border=0 class=\"width\"><TR><TD align=right>\n");
document.write("<a href=\"http://www.doxys.dk\" class=\"generatedDoxygen\" onmouseover=\"overLibGeneratedByDoxyS();return overlib('Generated by DoxyS 0.97<br>Wed Apr 16 16:50 2008');\" onmouseout=\"return nd();\">Generated by DoxyS</A>\n");
document.write("</TD><TD class=\"sideIndent\"><img src=\"");
document.write(relPathToCommmon);
document.write("dot.gif\" class=\"sideIndent\"></TD></TR></table>\n");
document.write("</div>\n");
document.write("</td></tr>\n");
document.write("</table>\n");
}
特别注意 link http://www.doxys.dk
和字符串 Generated by DoxyS 0.97<br>Wed Apr 16 16:50 2008
.