我这里在cmake -G "Unix Makefiles"老提示unable to determine iconv() signature 中文知道什么意思,不知道该怎么解决
本问题来自阿里云开发者社区的【11大垂直技术领域开发者社群】。https://developer.aliyun.com/article/706511 点击链接欢迎加入感兴趣的技术领域群。
命令:
1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2) cd doxygen-1.7.4
3) ./configure
4) make
5) make install
安装后需留意下doxyg的路径,例如:/usr/bin/doxygen
6) 进入项目目录(test为例说明) cd test/
7) 生成配置文件 Doxygen –g
l 默认生成的配置文件名为 "Doxyfile",也可以采用 "doxygen -g your-cfg-filename" 命令格式指定所生成的配置文件名。如无特殊需要,采用默认的配置文件名即可。
l Doxyfile 文件内容非常多,大概 1000 多行,不过其中约 4/5 都是注释,每个配置选项都有一段详细的注释。日后,如果对 Doxygen 各配置选项的意义有一定了解,可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件,操作如下:$ doxygen -s -g
3)配置文件的相应设置 ,这里已经有个模板Doxyfile(test文件夹下),可以根据需要更改相应设置
PROJECT_NAME = “Test
PROJECT_NUMBER = "1.0.0
OUTPUT_DIRECTORY = doc/
OUTPUT_LANGUAGE = Chinese
OPTIMIZE_OUTPUT_FOR_C = YES
TYPEDEF_HIDES_STRUCT = YES
HIDE_SCOPE_NAMES = YES
QUIET = YES
FILE_PATTERNS = *.h
RECURSIVE = YES
EXAMPLE_PATH = example/
EXAMPLE_PATTERNS = *.c \
*.h
EXAMPLE_RECURSIVE = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
GENERATE_LATEX = NO
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
#让doxygen从配置文件所在的文件夹开始,递归地搜索所有的子目录及源文件
RECURSIVE = YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCE BROWSER = YES
$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW = ALL
Doxygen 的注释类型可分为:
l 行间注释:注释语句不与程序源码出现在同一行,主要用于注释头文件中出现的结构体 (struct)、枚举 (enum)、联合 (uion) 等数据类型,以及程序接口的功能与使用约定;
l 行内注释:注释语句与程序源码出现在同一行内,主要用于代码的局部注释。
注释的种类有很多,下面是其中的一种:
Doxygen 认可的行间注释标记见下例:
/**
Doxygen 认可的行内注释标记见下例:
typedef struct { double coord[3]; /// 这是行内注释示例
}M2_3D_Point;
$ doxygen your-cfg-filename
your-cfg-filename 是 Doxygen 配置文件名,如果是使用 "doxygen -g" 生成的配置文件——Doxyfile,那么可以在终端里仅键入 "doxygen" 命令即可生成程序文档。
生成的文档位于 test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果。
Name :doxygen
Executable:/usr/bin/doxygen
Parameters:配置文件名,(如果doxygen –g 生成的默认配置文件,在这里不需要写)
Working directory:test(要生成程序文档的项目路径)
5.2 使用: 当需要生成程序文档时:Tools->doxygen 即可。生成的文档位于 test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。