码迷,mamicode.com
首页 > 其他好文 > 详细

生成 Qt 文档

时间:2015-09-01 12:08:17      阅读:1384      评论:0      收藏:0      [点我收藏+]

标签:

个人总结

   从命令行进入Qt安装目录
    设置环境变量
    set path=D:/mingw32/bin;D:/Qt/5.0.0/qtbase/bin;D:/icu/bin;D:/icu/lib
    
    运行 mingw32-make docs
    
    进入到qtbase/doc
    将qtdoc.qch注册到asstant
    assistant -register qtdoc.qch
========================================================================

翻译自qtdoc下面的readme
    qtdoc涵盖了Qt主要的参考文档,包括include,oveviews,Qt topics,以及非特定模块的example。其配置文件位于qtdoc/doc/config,文本内容位于qtdoc/doc/sc。需要指出的是 QDoc位于qtbase下面。
    本教程假设所需工具均已编译好,并且正确设置在环境变量PATH%中(在需要的时候能够被其他程序和命令找到)。
  1. 前提条件:
  2.     *qtbase存在
  3.     *qmake和qdoc已经编译和安装好
  4.     *要用到的Qt资源存在 
    Qt参考文档中各个模块以链接的形式存在。若某个模块或者资源不存在,那么生成的文件中将包含若干死链。
    有两种方法获得文档。一种是使用QDoc和配置文件(qdocconf)来编译文档,对应一;另一种方法是运行qmake(命令为make docs),对应二、三。

一、使用qdocconf文件进行构建
    这种方法适用于构建不依赖其他项目的单独项目。
    运行qdoc,使用qdocconf文件(文件路径)作为其参数(输入)。qdoc位于qtbase资源中。另外一个强制参数是outputdir,用于指定文档的安装目录(输出)
  1.     $> qdoc doc/config/qtdoc.qdocconf -outputdir html
    注意:QDoc会将安装目录html下所有内容删除清空。

二、使用make命令进行构建
    QMake从变量QT_INSTALL_DOCS获取Qt5文档的安装位置。这个方法产生的文档可以链接到其他模块。
    使用以下命令查看文档的安装位置(即变量QT_INSTALL_DOCS所指示的路径):
  1.     $> qmake -query
    生成文档:   
  1.     $> cd qtdoc #or whichever repository‘s root
  2.     $> qmake
  3.     $> make docs    
    make docs在Qt5总资源中同样可以工作。在其中运行这个命令会生成Qt5文档,并且将其安装到QT_INSTALL_DOCS所指示的位置

三、构建Qt文档
    使用如下命令将Qt模块文档与Qt参考文档一起进行构建:
  1.     $> cd qt5 #the main qt5.git directory
  2.     $> make qmake_all #creates Makefiles for each repository
  3.     $> make docs   
    将make docs替换成make html_docs可以只生成HTML文件。
四、打包文档   
    如果需要在QtAssitant中浏览文档,所有html文件都必须编译打包成QCH文件(.qch)
  1.    所需工具
  2.    *assistant      - 能够在qttools中找到
  3.    *qhelpgenerator - 能够在qttools中找到
    为每个模块编译qch文件:进入到输出目录(含有.qhp文件),编译生成QCH文件。
    输出目录即变量QT_INSTALL_DOCS所指示的路径。
  1.     $> cd qtbase/doc/qtdoc           #QT_INSTALL_DOCS默认值
  2.     $> qhelpgenerator qtdoc.qhp      #创建名为qtdoc.qch的QCH文件
    或者,当模块含有一个qch_docs目标项时:
  1.     $> cd qtbase
  2.     $> make qch_docs #builds the QCH files for modules in qtbase
    QCH文件现在能够被Qt Assistan或Qt Creator载入。如果想要Qt Assistant自动载入它们,还需要进行注册:
  1.     $> assistant -register qtdoc.qch 
  2.        #注册文档,使assistant自动将其加载

生成 Qt 文档

标签:

原文地址:http://www.cnblogs.com/aslistener/p/4775114.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!