名稱空間內的模板 class 內的 Doxygen 引用

[英]Doxygen references inside a template class inside a namespace

在下面的最小示例中，我在命名空間中有一個模板 class。 每個成員的描述都引用了另一個成員。/// @brief My namespace namespace template_test { template <int param_v> class TemplateClass { ...

沒有擴展的文檔宏

[英]Document macro without expansion

在我使用 doxygen 1.9.1 記錄的 C 項目中，我有幾個記錄的宏，例如/** * @brief Does a thing. */ #define DO_THING() someFunc(1, 2, 3) 當我生成文檔時，列出了DO_THING但它顯示了擴展（即someFunc(1, ...

在 Doxygen 中記錄命令

[英]Documenting command in Doxygen

我在 C++ 中創建了一個簡單的庫，並且在 Doxygen 中以相當好的紀律記錄了 API。 在 package 中有幾個示例程序可以使用該庫。在同一個 Doxygen 進程中記錄這些（作為命令行程序）是否有技巧？ ...

有時無法解析 Doxygen 基類

[英]Doxygen base classes not resolved sometimes

我有一個 C++ 庫，其中包含幾個用 Doxygen 樣式注釋記錄的源文件。 在庫中，有三個 class 模板（ Array 、 Vector 、 Span ）都繼承了相同的基礎 class 模板（ VctrBase ）。 我在 Doxyfile 中將INLINE_INHERITED_MEMB設置為 ...

記錄包含 header 個文件 in.c 個文件，帶有 Doxygen 注釋？

[英]Documenting included header files in .c files with Doxygen comments?

我注意到，當使用 Doxygen 記錄 a.c 文件時，給定文件中包含的列表也包含在 output 中，例如： https://agnix.sourceforge.net/documentation/api/bridge_8c.html 現在，我通常做的是在給定的“include block” ...

使全局 constexpr 變量出現在 doxygen 文檔中

[英]Make global constexpr variable appear in doxygen documentation

我正在處理一個 C++ 項目，該項目公開了許多構成界面重要部分的全局constexpr變量。 我已經像這樣記錄了所有這些 （有關更多代碼上下文，請參見此處）。 現在，當運行 doxygen 時，會呈現在同一源文件中聲明的 class 的文檔，但沒有該變量的文檔。 我已經嘗試了一些配置選項，但到目前 ...

隱藏文件時記錄 C++ 宏

[英]Document C++ macros when hiding files

我正在使用doxygen記錄一個 C++ 項目。 在這個項目中，有一些宏被正確記錄在代碼中。 在我的 doxyfile 中，我指定我不想要這樣的文件選項卡： 問題是這樣做時，我無法看到宏文檔，因為它似乎只能通過“文件”選項卡訪問： 我想要的是能夠在不提供文件文檔的情況下查閱宏文檔。 有什么辦法可以 ...

如何指定 doxygen @examples 的順序

[英]How to specify ordering for doxygen @examples

Doxygen 有一個@example標簽，用於在生成的文檔末尾的補充部分中包含示例。 這似乎工作正常，但示例是按文件名排序的，最好在不修改文件名的情況下控制它們的順序。 如果您有 50 個示例並且在中間插入一個新示例將是一場悲劇，則尤其如此。 有一些選擇可以做到這一點嗎？ ...

Doxygen 1.8.18 - 嵌套結構鏈接生成

[英]Doxygen 1.8.18 - Nested structure link generation

我正在使用 doxygen 1.8.18，並希望在 html 生成的嵌套結構中的變量文檔中有一個鏈接。 我正在嘗試為以下場景建立鏈接： 為變量和定義它的結構創建鏈接是有效的： 但是我的目標是為嵌套結構中的變量創建一個鏈接： 這是受支持的還是我做錯了？ 定義結構的所有文件都包含在 doxyfile 配 ...

如何使用 doxygen 確保命名空間中的每個結構出現相同的注釋

[英]How to ensure that the same comment appears for each struct in a namespace using doxygen

我在名為impstrcts.h的文件中有以下命名空間和一些代碼 有沒有辦法讓一般的 doxygen 注釋單獨出現，或者可能與名稱空間中的每個結構一起出現？ 因為現在， some doxygen for the collection of label_str, Label_map, big_map只出 ...

防止MyST改變.md圖片路徑

[英]Prevent MyST from changing .md image paths

我正在使用通過相對路徑引用圖像的 .md 文件生成 sphinx 文檔： .[](../_static/figures/image.png) 我使用 MyST 將 .md 文件解析為 html，但它刪除了../'制作所有路徑： _static/figures/image.png 。 相對路徑在文檔 ...

使用 doxygen，什么時候應該將注釋放在實體之前，什么時候放在實體之后？

[英]With doxygen, when should the comments be placed before the entity, and when after?

這里有兩個 styles 對實體的評論（例如，在類似 C/C++ 的語言中）。 款式一： 樣式 2： 我知道，通常，在編寫 doxygen 注釋時，它通常出現在記錄的實體之前，例如： 情況總是如此，還是我可以將它放在實體之后，就像上面的第二種評論風格一樣？ ...

我如何根據 doxygen 的體系結構分段組織文件？

[英]How can I organize files in sections according to an architecture with doxygen?

我正在嘗試使用 Doxygen 記錄我的代碼。 我希望生成的 HTML 根據 SW 架構組織樹視圖，以便簡單快速地理解項目。 我有一個這樣組織的項目： 我遇到的問題是 doxygen 自動生成的樹視圖是扁平的。 所有元素都具有相同的級別。 當前結果是： 我的目標是擁有這樣的東西： 我對分組和部 ...

所有 md 文件都顯示在根結構中，而不是 doxygen 中的層次結構

[英]All of md files are showing in root structure instead of a hierarchy in doxygen

我有一個具有這種結構的項目： 但是，所有這些文件都顯示在根目錄中，沒有任何層次結構。 我沒有遵循上面的結構，而是得到了這個結構： 我怎樣才能在 doxygen 的文檔中得到這個結構？ ...

Doxygen：將結構記錄為結構的成員

[英]Doxygen: Documenting struct as a member of a struct

我想將一個結構記錄為一個結構的成員，在一種風格中，將有一個指向預先計算的結構的可點擊鏈接，與calibrator_calibration_t上的結構相同，單擊后它將向我顯示precalculated的所有成員。 生成 HTML： 我嘗試了許多不同的方法，但沒有一種方法能滿足我的需要。 任何提示？ ...

Doxygen打印bash文件內容

[英]Doxygen print bash file contents

I have a project with bash, python, and C files where I would like to simply print the contents of the bash file in the doxygen documentation. 我正在使用 ...

多語言 API 的 Doxygen 鏈接

[英]Doxygen links for a multi-language API

我們使用 Doxygen 為我們的軟件庫生成 API 和相關文檔。 該庫是用 C++ 編寫的，公開了一個 C 接口，並包括其他語言的包裝器，例如 C# 和 ZA37241719.324265B69。 許多包裝語言使用與 C API 相同的結構/類名稱。 當 Doxygen 找到其中一個時，它總是鏈接 ...

python function 文檔字符串中的空行破壞了 Doxygen 特殊命令

[英]Blank line in python function docstring breaks Doxygen special commands

在 class 內的 function 的文檔字符串中添加空行會破壞 Doxygen 特殊命令的解析。 這有效 但這並不 當文檔字符串中的空行不在 class 函數中時，它們是可以的，因此缺乏一致性。 出於美學原因，我喜歡空白行並打破描述中的輸入。 如何使它與空行一起使用？ ...

將自動生成的 UML 圖嵌入到 LaTeX output

[英]Embedding auto-generated UML diagrams to LaTeX output

是否可以在 LaTeX output 中嵌入使用UML_LOOK = YES生成的 UML 圖？ 編輯： 我正在使用 Doxygen 1.9.1。 doxygen -x Doxyfile的 output 看起來像這樣： 對於像這樣的最小源文件 HTML output 包含這種圖： 但 LaT ...

即使啟用了遞歸搜索，Doxygen 也不會處理子目錄中的類

[英]Doxygen does not process classes in subdirectories even with recursive search enabled

我一直在努力使用 Doxygen（和 DoxyWizard）為 VC++ 項目生成完整的文檔。 這是目錄結構： 我關心的唯一類位於Project1/Project1目錄中。 Ah 、 Bh和C.h包含抽象基類。 派生類位於各自的 A、B 和 C 目錄中。 因此，例如，文件Project1/Proj ...