【QCustomPlot】設定幫助檔案

2023-06-16 09:00:40

說明

使用 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 會開啟相應的幫助節選,如下所示。