我希望用什么文档工具来处理它?

时间:2015-06-30 16:45:56

标签: c documentation-generation

我有一个分发了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所需的文档工具吗?

1 个答案:

答案 0 :(得分:1)

DoxyS

如果进入rendered version of the documentation并检查HTML源代码(右键单击 - >查看页面源),则会在HTML顶部附近看到几个链接的Javascript文件。

<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");
}

请特别注意链接 http://www.doxys.dk 和字符串 Generated by DoxyS 0.97<br>Wed Apr 16 16:50 2008