# chatgpt.doxygen-c-doxyfile-doxywizard

**Repository Path**: zinface/chatgpt.doxygen-c-doxyfile-doxywizard

## Basic Information

- **Project Name**: chatgpt.doxygen-c-doxyfile-doxywizard
- **Description**: 由 ChatGPT 提供的 Doxygen 相关内容
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-01-04
- **Last Updated**: 2023-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 由 ChatGPT 提供的 Doxygen 相关内容

- Doxygen 相关内容

    Doxygen 是一个很流行的文档生成工具，它可以通过读取代码中的注释来生成文档。它不仅可以生成 HTML 和 PDF 格式的文档，还可以生成 LaTeX 和 man 格式的文档。它还可以生成图片和索引文件。有很多其他的文档生成工具可供选择，比如 Sphinx、Javadoc 和 Sandcastle。它们都有自己的特点，你可以根据自己的需要来选择合适的工具。

- 我应该如何使用 doxygen

    Doxygen 是一种用于自动生成文档的工具，它通过对源代码中的注释进行解析，然后生成 HTML 或 LaTeX 格式的文档。

    使用 Doxygen 非常简单，你只需要在你的源代码中加入足够的注释，然后使用 Doxygen 生成文档即可。

    你可以使用如下命令来生成 Doxygen 文档：

    ```shell
    doxygen [configuration file]
    ```

    其中，configuration file 是一个配置文件，用来指定 Doxygen 生成文档的方式。你可以在这个文件中设置生成文档的输出格式、输出目录、注释风格等选项。

    你也可以使用 Doxywizard 工具来创建和编辑 Doxygen 配置文件，这样可以使你更方便地设置 Doxygen 生成文档的选项。

    常用的 Doxygen 配置选项有：

    * PROJECT_NAME：项目名称。
    * INPUT：需要生成文档的源代码文件路径。
    * OUTPUT_DIRECTORY：输出文档的目录。
    * OUTPUT_LANGUAGE：输出文档的语言（默认是英文）。
    * EXTRACT_ALL：是否提取所有注释（包括未被文档标记的注释）。
    * EXTRACT_PRIVATE：是否提取私有成员的注释。
    * EXTRACT_STATIC：是否提取静态成员的注释。

- 常用的 Doxygen 配置选项

    下面是一些常用的 Doxygen 配置选项：

    - `PROJECT_NAME`: 设置项目名称。
    - `OUTPUT_DIRECTORY`: 设置输出文档的目录。
    - `INPUT`: 设置要处理的源代码文件或目录。
    - `EXCLUDE`: 设置不需要处理的文件或目录。
    - `FILE_PATTERNS`: 设置要处理的文件类型。
    - `RECURSIVE`: 设置是否递归处理子目录。
    - `EXTRACT_ALL`: 设置是否提取所有代码。
    - `EXTRACT_PRIVATE`: 设置是否提取私有成员。
    - `EXTRACT_PACKAGE`: 设置是否提取包成员。
    - `EXTRACT_STATIC`: 设置是否提取静态成员。
    - `EXTRACT_LOCAL_CLASSES`: 设置是否提取局部类。
    - `EXTRACT_LOCAL_METHODS`: 设置是否提取局部函数。
    - `HIDE_UNDOC_MEMBERS`: 设置是否隐藏未文档化的成员。
    - `HIDE_UNDOC_CLASSES`: 设置是否隐藏未文档化的类。
    - `HAVE_DOT`: 设置是否使用 Graphviz 生成图形。
    
    这些配置选项可以在 Doxygen 的配置文件（通常为 Doxyfile）中进行设置。

- 请给我一点示例

    可以尝试使用以下示例来生成 Doxygen 文档：

    ```c
    /*!
     * \file
     * \brief This is a brief description of the file.
     *
     * This is a detailed description of the file. It can span multiple lines.
     *
     * \author John Doe
     * \date 2021-01-01
     */
    
    #include <stdio.h>
    
    /*!
     * \brief This is a brief description of the function.
     *
     * This is a detailed description of the function. It can span multiple lines.
     *
     * \param x This is the first parameter of the function.
     * \param y This is the second parameter of the function.
     * \return This is the return value of the function.
     */
    int add(int x, int y)
    {
        return x + y;
    }
    
    int main(void)
    {
        printf("%d\n", add(1, 2));
        return 0;
    }
    
    ```
    
    然后使用以下命令来生成文档：

    ```shell
    doxygen -g # 生成配置文件
    doxygen # 使用配置文件生成文档
    ```

    生成的文档会存放在一个新的目录中，默认为 "html"。

    你也可以使用 Doxywizard 来轻松配置 Doxygen 并生成文档。

----

### 以下是使用 Doxywizard 配置过的内容:

> 注意: Doxywizard 使用前先生成配置，再使用 'File->Open' 选中 Doxygen 配置文件

- Wizard
    - -> Project
        - 修改了 `PROJECT_NAME` 为 `Hello World`
    - -> Output
        - 取消选中生成 `Latex` 的选项

- Export
    - -> Project
        - 修改了 `OUTPUT_LANGUAGE` 为 `Chinese`

----

![](chatgpt-doxygen.png)