【QCustomPlot】配置帮助文档

说明

使用 QCustomPlot 绘图库辅助开发时整理的学习笔记。同系列文章目录可见 《绘图库 QCustomPlot 学习笔记》目录。本篇介绍 QCustomPlot 帮助文档的配置。


1. 在线帮助文档

QCustomPlot 在线帮助文档(最新版库文档):https://www.qcustomplot.com/documentation/index.html

2. 离线帮助文档下载

官网 - QCustomPlot 或者 百度网盘 - QCustomPlot 上下载压缩包 QCustomPlot.tar.gz,这个压缩包中包含帮助文档的 HTML 版本及 QCH 版本。

2.1 HTML 版的离线帮助文档

压缩包解压后,跳转到 qcustomplot\documentation\html 目录下,所有 .html 文件即为 HTML 版本的帮助文档,排版格式与在线版的帮助文档一样,直接双击打开就可。

2.2 QCH 版本的离线帮助文档

压缩包解压后,跳转到 qcustomplot\documentation 目录下,其中 qcustomplot.qch 就是可以集成进 QtCreator/QtAssistant 的帮助文档,官网 - QCustomPlot - Documentation 有对集成方法做了说明。分为以下三步:

(1)拷贝文件。将 qcustomplot.qch 文件拷贝到 QT 安装目录下,比如内部库帮助文档所在目录(我的是 D:\Qt\Qt5.9.2\Docs\Qt-5.9.2),如下所示:

(2)配置选项。打开 QtCreator,从菜单栏依次点击 工具 -> 选项(O)... -> 帮助 -> 文档,然后点击 添加... 将上一步拷贝路径下的 qcustomplot.qch 文件添加进去,最后点击右下角的 OKApply 按钮。

(3)重启 QT。以上两步完成后,重启 QtCreator/QtAssistant,才能正常使用 qcustomplot.qch,当光标在某个 QCustomPlot 类方法名称上时,按 F1 会打开相应的帮助节选,如下所示。