oxyincludedoc的Doxygen使用 [英] Doxygen usage of \includedoc

问题描述

Doxygen文档关于 \includedoc 该命令的作用方式与 \include 相同，但是它将包含文件的内容，就好像它位于此命令的调用位置一样。 / em>

所以我设置了 EXAMPLE_PATH = includepages （Doxyfile），并创建了一个名为 test的文件。 includepages 子文件夹中的dox 。

为确保用法正确，这是<$的内容c $ c> test.dox ：

  / *！ 
 *这是一项测试
 * / 
这是另一项测试
  

此处这就是我包含此页面的方式：

  * \include test.dox 
 * 
 * \includedoc test .dox 
  

这将导致：

您看到的 \包括test.dox 的工作原理与预期的一样。给出文件 test.dox 的none doxygen部分（这是另一项测试）。
但是不是打印这是一项测试 c \includedoc test.dox 而不是打印文件名？
我不知道出了什么问题。

感谢帮助

汤姆

系统信息（SuSE Leap 42.2）

 ＃uname -a 
 Linux twa 4.4.74-18.20-default＃1 SMP Fri Jun 30 19:01： 19 UTC 2017（b5079b8）x86_64 x86_64 x86_64 GNU / Linux 
＃doxygen --version 
 1.8.11 
＃点-V 
点-graphviz版本2.38.0（20140413.2041） 
  

解决方案

我终于成功使用了最新的Doxygen版本。 / p>

以下是在Linux上使用Doxygen 1.8.13的快速方法：

  wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.13.src.tar.gz 
 tar xvf doxygen-1.8.13.src.tar.gz 
 cd doxygen-1.8.13 / 
 cmake -G Unix Makefiles 
 make 
 sudo mkdir /opt/doxygen-1.8.13 
 cp bin / doxygen / opt / doxygen -1.8.13 
  

现在，您可以通过调用 doxygen选择使用发行版维护版本或您自己的版本v通过致电 /opt/doxygen-1.8.13/doxygen 来结束。

the Doxygen documentation says about \includedoc "This command works the same way as \include, but it will include the content of the file as if it were at the place where this command is called."

So I set up EXAMPLE_PATH = includepages (Doxyfile) and created a file named test.dox in includepages sub folder.

To ensure that usages is correct this is the content of test.dox:

/*!
 *  THIS IS A TEST
 */
 THIS IS AN OTHER TEST

Here is the way I do Include this page:

 *  \include test.dox
 *
 *  \includedoc test.dox

This will result in:

As you see \include test.dox works like expected. The none doxygen part of the file test.dox is given (THIS IS AN OTHER TEST). But instead of printing THIS IS A TEST \includedoc test.dox prints the file name? I can't figure out whats wrong.

Thanks for helping
Tom

System information (SuSE Leap 42.2)

# uname -a
Linux twa 4.4.74-18.20-default #1 SMP Fri Jun 30 19:01:19 UTC 2017 (b5079b8) x86_64 x86_64 x86_64 GNU/Linux
# doxygen --version
1.8.11
# dot -V
dot - graphviz version 2.38.0 (20140413.2041)

解决方案

I finally succeed in using the latest Doxygen version.

Here is a quick path to use Doxygen 1.8.13 on Linux:

wget http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.13.src.tar.gz
tar xvf doxygen-1.8.13.src.tar.gz 
cd doxygen-1.8.13/
cmake -G "Unix Makefiles"
make
sudo mkdir /opt/doxygen-1.8.13
cp bin/doxygen /opt/doxygen-1.8.13

Now you have the choice of using your distribution maintained version by calling doxygen or your own build version by calling /opt/doxygen-1.8.13/doxygen.

这篇关于oxyincludedoc的Doxygen使用的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！