☰

如何在 Ubuntu 上安装 Doxygen？

tag-icon • tag-icon doxygen
如何在 Ubuntu 上安装 Doxygen？

我doxygen-1.8.20.linux.bin.tar.gz在这里下载的：https://www.doxygen.nl/download.html。

如何在 Ubuntu 20.04 上安装它？

答案1

此软件已经包装在 Ubuntu 20.04 LTS 中存储库具有现代和实际的 1.8.17 版本。

只需打开终端并运行

sudo apt-add-repository universe
sudo apt-get update
sudo apt-get install doxygen

然后按计划使用它。

答案2

我doxygen-1.8.20.linux.bin.tar.gz在这里下载的：https://www.doxygen.nl/download.html。

如何在 Ubuntu 上安装

下载并安装最新版本的doxygen（doxywizardGUI）

为了任何Ubuntu 版本：

在 Ubuntu 22.04 上测试。

点击这里下载最新版本：https://www.doxygen.nl/download.html

...或者来自官方 GitHub 发布页面的旧版本或最新版本：https://github.com/doxygen/doxygen/releases

解压.tar.gz文件，制作并安装。假设您想要的版本是doxygen-1.10.0.linux.bin.tar.gz，完整的下载、制作和安装说明如下：

# Create a directory where you want to download it
mkdir -p ~/Downloads/Install_Files/Doxygen
cd ~/Downloads/Install_Files/Doxygen

# download it
wget https://github.com/doxygen/doxygen/releases/download/Release_1_10_0/doxygen-1.10.0.linux.bin.tar.gz

# extract it
tar -xf doxygen-1.10.0.linux.bin.tar.gz

# cd into the extracted directory
# - Note: this directory already has a `bin` dir with prebuilt binary
#   executables. 
cd doxygen-1.10.0

# make and install it
sudo make
sudo make install

# Ensure it's installed
# Example output:
#
#       1.10.0 (ebc57c6dd303a980bd19dd74b8b61c8f3f5180ca)
#
doxygen --version

# Check your man pages available by typing `man doxy` and pressing Tab twice. 
# Output:
#
#       doxygen      doxyindexer  doxysearch   doxywizard  
# 

# View those man pages
man doxygen
man doxyindexer
man doxysearch
man doxywizard

上面下载的 doxygen 附带的其他工具可以在doxygen-1.10.0/bin/您从.tar.gz上面文件中提取的目录中找到。通过将该目录添加到您的环境变量中来访问这些可执行文件PATH。为此，请将以下几行添加到文件底部~/.bashrc：

# Add doxygen to the PATH
DIR="$HOME/Downloads/Install_Files/Doxygen/doxygen-1.10.0/bin"
if [ -d "$DIR" ]; then
    PATH="$DIR:$PATH"
fi

现在重新启动~/.bashrc文件以应用更改，并测试新的可执行文件：

# re-source your ~/.bashrc file
. ~/.bashrc

# Install the libxapian.so.30 shared object library, required by 
# `doxysearch.cgi`
# Note: If you are missing this library and you run `doxysearch.cgi`, you'll
# see this error:
# 
#       doxysearch.cgi: error while loading shared libraries: libxapian.so.30: 
#       cannot open shared object file: No such file or directory
#
sudo apt update
sudo apt install libxapian30

# Test the new doxygen executables from the `doxygen-1.10.0/bin/` dir
doxygen --version  # should be the same as above
doxyindexer --version
doxysearch.cgi --version
doxywizard --version  # opens a GUI popup window with version info.

要运行基于 GUI 的 doxygen 配置文件编辑器，请doxywizard在命令行中运行。

安装 GraphViz

doxygen需要 GraphViz 通过实用程序生成调用图和类图dot。因此，请安装 GraphViz 和dot实用程序，如下所示：

sudo apt update
sudo apt install graphviz

# Ensure it is now installed
dot -V  # shows the version

使用doxygen可执行文件

Doxygen 的基本用法：

# Create a new Doxygen configuration file named Doxyfile
doxygen -g Doxyfile

现在，您可以根据自己的喜好进行编辑，可以手动编辑，也可以通过运行Doxyfile在 GUI 工具中编辑。doxywizarddoxywizard

您还可以使用doxywizardGUI 创建和编辑配置文件。只需在命令行中Doxyfile运行即可。有关更多信息，请参阅下文。path/to/doxygen-1.10.0/bin/doxywizard

然后，运行doxygen以生成文档（请注意，time只需计算需要多长时间，并且是可选的）：

time doxygen Doxyfile

Doxyfile 配置

有关更多信息和推荐的设置，请参阅我的eRCaGuy_dotfiles回购这里：Doxygen 安装和设置。

我那里也有这些文件：

  1. Doxyfile_CUSTOMIZED- 在阅读下面的“设置和使用”部分后，我的 doxygen 配置文件具有我推荐的设置。
  2. Doxyfile_DEFAULT- 运行后创建的默认 doxyfile doxygen -g Doxyfile。
  3. Doxyfile_run_doxygen.sh- 脚本用于：
    1. 为 C 或 C++ 项目自动生成 Doxygen 文档
    2. 将 repo 信息存储到 path 中的特殊 readme 文件中"$OUTPUT_DIRECTORY/doxygen_info_README.md"，紧挨着 doxygen 输出，然后
    3. index.html在 Google Chrome 网络浏览器中打开Doxygen 输出网页。

相关内容