docwizard.txt

c＋＋文档生成工具

Doc Wizard 1.0.0.1


                    sun,
                    [e-mail],
                    [e-mail],
                    sun@urtsoftserver
                    2003-2-21
                    http://www.betajin.com/alphasun/

======================================================
    FORWORD
======================================================

您在写文档时是否被数量众多的类成员函数所烦恼？是否为了形成美观
的版面、格式而困扰？是否为了做成CHM而不得不进行大量的手工操作？
本软件可以帮助您

    ●  生成C++的类的HTML格式的文档，条分缕析，版面美观而朴实。
        并且可以集成到 HTML Workshop 中，和其他类一起形成CHM。

    ●  而且可以生成 content of topic (.hhc) 文件以及生成
        index (.hhk) 文件。避免您手工编辑生成文件的麻烦。要知
        道在 HTML Workshop 中编辑生成这两种文件是非常麻烦的。

    ●  在马上就要推出的新版本中，将提供二次开发接口，您将可以
        操纵文档生成过程，形成更符合您要求的文档。当然源代码的
        解析本软件已经帮您完成了，您所要做的仅仅是生成您所关心
        的“部分”文档。


======================================================
SYSTEM REQUERMENTS
======================================================
    本软件用VC++ 6.0 sp5开发，为了减小压缩包的大小，所以压缩包里
    面没有相关的动态链接库。所以各位需要自己配备。当然啦，大家都
    用VC的，这些东西肯定是有的。


======================================================

1. 基本概念

本工具是用来生成C++类的HTML文档的，另外还可以生成 HTML Workshop
所需要的hcc，hhk文件，方便你把文档编译成CHM。

首先用 HTML Workshop 创建你的工程，你会得到一个工程目录，
你用 DocWizard 生成的文档一定要放到工程目录下面，可以建子目录。
界面上的 "TechDoc根目录" 就是你的CHM工程目录，"存放目录" 是
工程目录之下的目录。

这些用来设定目录的edit，都是可以接受从资源管理器拖过来的目录或者
文件的。请先激活你所需要的edit，激活的edit是绿色的。

DocWizard 生成的 hcc, hhk 文件请通过手工编辑的方式加入到
HTML Workshop 生成的 hcc, hhk 文件中去。接下来，编译你的CHM工程就
可以了。


======================================================

2. 解释界面上的控件

使用本地路径 提供文档存放目录 (Radio Box)

    选择这个Radio Box您将可以生成正确的Contents文件和Index
    文件，并且可以将文档直接生成到Solid2000TechDoc目录中。

    单击Edit控件使其获得焦点，然后拖动目录到对话框上。

    总共有两个参数需要设置。设置完毕之后就可以生成content
    文件和index文件需要的如下形式的路径：
    <param name="Local" value="Solid2000开发\Solid2000系统基础层\数学库\SGeomTool\AngleCoincide.htm">

    ###################################
    TechDoc根目录(d:\\Solid2000TechDoc)
    这个目录是所有的 Solid2000 Tech Doc 存放的根目录。请
    使用完整路径。

    ###################################
    存放目录(目标目录) (d:\\Soli...\\SomeTopic)
    存放您所处理的类的文件夹的目录。请使用完整路径。


使用CHM虚拟路径 提供文档存放目录(目标目录) (Radio Box)

    如果选用这个Radio Box，则只能生成Contents文件和Index
    文件，但是不能把文档生成到Solid2000TechDoc目录中。

    单击Edit控件使其获得焦点，然后拖动目录到对话框上。

    这个参数将用于生成如下形式的代码：
    <param name="Local" value="Solid2000开发\Solid2000系统基础层\数学库\SGeomTool\AngleCoincide.htm">
    您所提供的路径可能是
    Solid2000开发\Solid2000系统基础层\数学库\


生成index文件 (Check Box)
    选中这个选项将可以生成index文件。类名和所有的函数名
    将作为关键字。关键字对应的文件形式如下:
    Solid2000开发\Solid2000系统基础层\数学库\SGeomTool\AngleCoincide.htm
    所以需要设置相应的路径，参见上面两个Radio Box的说明。


生成Contents文件 (Check Box)
    Contents文件的结构是

    [ClassName]
        成员函数
            [function1]
            [function2]
            [function3]
    是否有 “成员函数” 这个节点可以在对话框上设置。


下面有一级ClassMember结点 (Check Box Class)
    见上一条。


生成到 (Radio Box)
    可以选择生成到目标目录；可以生成到 Solid2000TechDoc 目录，
    也可以选择生成到头文件所在目录。

要处理的头文件 (Edit)
    单击控件使其获得焦点，然后拖动文件到对话框上。

覆盖上次结果 (Check Box)
    选择这个 Check box，生成的文档文件 .htm 如果文件已经存在，
    则不提示。如果不 Check，则当有文件已经存在时会出现提示。


快捷菜单功能
    全部选中            全部选中当前激活列表中的项目，将其打勾
    统统不选            当前激活列表中的项目取消选择
    析构函数不选        取消析构函数的选择，其他函数不变

    只选择目标目录中没有的
                        这个功能可用于文档的补充

    反选                选择状态取反
    互相See Also        被选中的函数的生成文档中有自动产生的 See Also。
                        选中的item的See Also函数会在第二列显示 "S"。

    清除选中的item的see also列表
                        被选中的item的See Also列表将被清除

    清除两两之间的See Also
                        被选中的集合中，两两之间的See Also关系将被打断。

    自动See Also        自动产生See Also关系。请在使用此功能之前选择好
                        那些函数需要产生文档，因为不产生的文档将不会被
                        See Also。

    用浏览器看文件      设定用于浏览的程序
    编辑文件            设定用于编辑网页的程序
    详细资料,看个究竟   查看详细资料，用这个可以看到每一个重载函数以及
                        See Also列表

    设置浏览器          设置用于浏览的程序，在资源管理器的右键菜单
                        中，对于每一种文件类型都有一批程序可用于打开，
                        此处可以选择一个程序。

    设置编辑器          同上。

===============================================================
    FAQ
===============================================================

1.  Q 这是你的业余时间写的吗？
    A 不是，这是为了我们公司的开发工作能够更方便而写的小工具。
      现在我们公司的同事都在用这个工具生成 class  的文档。

2.  Q HTML Workshop 是什么？
    A 他是可以把 HTML 文件编译成 CHM 的工具，是 MS 开发的。

3.  Q 路径如果由浏览选择就好了
    A 推荐您从浏览器中拖拽到本程序中，这样比浏览更方便。
      推拽的时候请使得目的地的 EDIT 激活变成绿色。不过呢我
      在下个版本中会提供浏览的，谢谢您的建议。

4.  Q 生成 html 文件后里面留好了函数的参数说明，不知道你打算怎么让用户填进去？
    A 请使用 HTML 编辑工具，比如 Dreamwaver 或者 FrontPage。

5.  Q 生成的时候，让用户可以在程序界面中给函数的参数填写说明
    A 在界面中填写参数说明等，不如在 HTML 编辑工具中填写来得方便，
      而且功能更为强大。

6.  Q 这个工具修改我的源代码吗？
    A 绝对不可能，本工具只生成 HTML 文档，不会修改你的原代码。