OpenCASCADE6.8.0 Reference Manual Serach Problem

OpenCASCADE6.8.0 Reference Manual Serach Problem

eryar@163.com

1. Problem

有网友反映OpenCASCADE6.8.0的Reference Manual的搜索功能不好用,以前没注意,自己试了下,的确在本机上不能正确搜索出给出的关键字相关的内容。如下图所示,在搜索框中输入gp_Pnt:

wps_clip_image-5018

Figure 1. Search class gp_Pnt

结果没有出来想要的内容,如下图所示:

wps_clip_image-22508

Figure 2. Search Result in the Reference Manual

从上图可以看出,搜索使用了search.php来执行搜索功能,所以得出结论这个搜索功能需要放在支持php的服务器上才能正确执行搜索功能。即在OpenCASCADE的官网上是正确的,如下所示:

http://dev.opencascade.org/doc/refman/html/search.php?query=gp_Pnt

image

 

2. Solution

OpenCASCADE是使用Doxygen来根据源程序自动生成这个参考文档的,所以从源头上来分析,找出原因。若想生成些文档,需要如下图所示的第三方程序:

wps_clip_image-4753

Figure 3. Documentation System Prerequistes

下载好这些第三方程序后,只需要运行gendoc.bat批处理,即可自动生成这个Reference Manual了。如下图所示:

wps_clip_image-26631

Figure 4. Use gendoc.bat file to generate document automatically

其 实主要还是依赖了Tcl脚本的强大功能来查找及设置那些第三方程序,从而使文档生成自动化。从中可以看出,Tcl/Tk脚本在OpenCASCADE中的 又一应用,除了Draw Test Harness以外。所以,熟悉Tcl/Tk脚本不仅有利于对OpenCASCADE程序的Draw模块的理解,及其自动化测试的实现;还有利于平时为程 序开发提供一些自动化的脚本,来减轻程序开发过程中的一些机械劳动。运行gendoc.bat可以看到有如下选项:

wps_clip_image-17127

Figure 5. The options of gendoc.bat

从 上面的选项可以看出,生成文档时可以指定生成的格式,如html, pdf, chm;还可以指定生成OCCT的哪些模块需要生成Reference Manual;其中导致搜索有问题的是指定搜索模式,其中有4种模式可供选择:none/local/server/external,从中可以看出 OpenCASCADE的安装包中提供的是Server模式,所以在本机上不好用了。如果要在本机使用搜索功能,可以自己来生成这些文档,但是要指定搜索 模式为local。

3. Conclusion

OpenCASCADE使用Doxygen及一些第三方程序来自动生成文档,简化程序开发过程中的文档工作。尤其是Tcl/Tk脚本的使用,让重复机械的劳动由电脑来自动完成,提高工作效率及编程的乐趣。

如果想使用搜索功能,可以自己运行gendoc.bat并指定搜索模式为local即可解决问题。

4. References

1. OpenCASCADE Documentation System. 

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称表情代码图片