Linux环境下的Doxygen下载与安装 (doxygen 下载 linux)

Doxygen是一款常用的自动生成文档的工具,就像JavaDoc用于Java语言,Doxygen可以用于多种编程语言,如C++, Java, Python等等。在Linux环境下,Doxygen能够方便快捷的生成文档,这篇文章将介绍如何在Linux环境下下载和安装Doxygen。

1. 下载Doxygen

需要访问Doxygen的官方网站,从下面的链接下载最新的Doxygen版本:

https://www.doxygen.nl/download.html

在下载界面,可以选择稳定版本或者开发版本等等,将最新版本的下载链接复制,然后在Linux的终端中使用wget命令下载:

“`

wget https://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.20.src.tar.gz

“`

其中,版本号不一定是这个,应该替换成下载链接中的版本号。下载完成后,解压缩文件:

“`

tar xzvf doxygen-1.8.20.src.tar.gz

“`

2. 安装Doxygen

解压完成后,会生成一个名为doxygen-1.8.20的文件夹,进入该文件夹,并使用以下命令进行安装:

“`

cd doxygen-1.8.20

mkdir build

cd build

cmake -G “Unix Makefiles” ..

make

sudo make install

“`

以上命令将在Linux环境中编译和安装Doxygen。在编译和安装期间,可能需要一些额外的依赖项,如cmake、g++等等,需要根据提示进行安装。

3. 验证安装

安装完成后,可以使用Doxygen生成任何程序的文档。为了验证Doxygen的安装,可以使用以下命令生成一个简单的文档:

“`

doxygen -g config_file

“`

在控制台上运行以上命令,Doxygen将生成一个名为config_file的配置文件,用于生成文档。然后使用以下命令生成文档:

“`

doxygen config_file

“`

生成的文档位于doxygen-1.8.20文件夹中的doc文件夹下。

4.

本文介绍了在Linux环境下下载和安装Doxygen的详细过程,以及如何使用Doxygen生成文档。Doxygen是非常方便的文档生成工具,可以用于多种编程语言,通过本文的介绍,读者可以轻松方便的使用Doxygen并生成文档。

相关问题拓展阅读:

如何利用doxygen生成pdf文档

在代码中加入文档 这个是之一步,也是最重要的一步,直接影响着文档的优与劣.

Doxygen是一个比较成熟的工具了,它有非常详细且专业的文档.

文档是写在代码当中的,以注释块的形式,为了区分代码中的正常注释,访文档需要余亮用特殊的形式的注释块来呈现.Doxygen支持多种文档注释块:

Javadoc形式的:/** * … */QT形式的/*! * … */或者,这样/// /// … ///或者,这样//! //! .. //!后二种有点非主流,不建议使用.推荐使用前面二种.当然,配置了某些特殊的选项也可以使用其他格式.

当Doxygen看到这种形式的注释块时就会把它从代码中抽取出来,生成HTML形式的文档.

为了让文档更且有可读性,表达出更多的信息,Doxygen就定义了很多的命令,常用的有:

\file 告诉Doxygen这是某个文件的文档块\enum 给一个enum类型加文档\struct 给一个结构体加文档\param 函数的参数\return 函数的返回值\see 交叉参考\brief 简介,用于概览时控制在一行以内,可以空一行,然后写更多的详细的内容\code \endcode 示例代码\note 注意事项\par HTML中的 需要注意的是,这些命令也可以用javadoc格式的来写如@file, @enum, @return等.但建议用标准格式,因为\只需要敲一下,而@需要敲二下,另外就是并不是所有的命令都支持javadoc格式.

还有就是如果想写交叉引用可以在前面加个#就会自动转为相应的链接,直接上个例子就都明白了:/** * \携毁轮brief Obtain current list of path * * \param paths a pointer to an array of strings * \param count indicating the count of path. * * \note * This function will allocate memory for path array. So caller must free the array, but should not free each item. * * \return #API_RESULT_CODE indicating whether this call success or failed. * * \par Sample code: * \code * char **path = NULL; * int count = 0; * test_get_paths(&path, &count); * // use the path * free(path); * path = NULL; * \endcode */ int test_get_paths(char ***paths, int *count);配置Doxygen Doxygen需要一个配置文件来告诉Doxygen一些选项.配置文件就是一个纯文本文件,格式跟标准的Linux配置文件一样:一行一个配置项,前面是配置项的名字,然后是等号后面辩信就是配置项的值了.以#开头都是注释.Doxygen的选项特别的多,不可以手动的去写,通常都是编辑一个现有的模板,这个模板可以用Doxygen来生成:

doxygen -g config-filename

PROJECT_NAME 项目的名字,一定要改成你项目的名字PROJECT_NUMBER 编号,通常使用项目的版本号OUTPUT_DIRECTORY 文档输出存放目录,建议修改,比如docPROJECT_BRIEF 项目的描述,会出现文档每一页的上面,控制在一行80字符内(越短越好)EXTRACT_*** 打头的选项要仔细读,如果是API文档,则这些全都要设成NO,这样就仅抽取特定文档块内的内容. 其他的选项都可以不改,用默认的就成.

生成文档 这步最简单,如果前面都就绪了,仅需要运行命令即可:

doxygen config-filename

后,文档就会出现在所指定的输出目录中.

doxygen会打印出日志信息.为了保证质量,更好把把的Warning都修正掉.(这跟修正代码的所有编译警告一个道理).上面例子生成的文档:int test_get_paths(charpaths, int * count ) Obtain current list of path. Parameters:pathsa pointer to an array of stringscountindicating the count of path.Note:This function will allocate memory for path array. So caller must free the array, but should not free each item.Returns:API_RESULT_CODE indicating whether this call success or failed.Sample code:char **path = NULL; int count = 0; test_get_paths(&path, &count); // use the path free(path); path = NULL; 完整示例下载

帮我推荐一本书,有关FLASH游戏制作的或c++游戏制作的书.谢谢!我是菜鸟啊!

Game Developer Magazine年,共7年的游戏开发者杂志电子版(含源码)

Graphics Programming Black Book (by Michael Abrash).zip,图形编程黑书,Id software的Michael Abrash编著

Game Programming Gems I.rar ,游液羡戏编程精滑前粹I、II(含源码)

Game Programming Gems II.rar

Graphics Gems I.rar ,图形学精粹I、II、III、IV、V

Graphics Gems II.rar

Graphics Gems III IBM.rar

Graphics Gems IV IBM.rar

Graphics Gems V.rar

Computer Graphics, C Version (2nd Ed.).rar ,计算机图形学C版(第二版)

half_life2_engine.zip ,半条命2游戏引擎源代码

D3DTutorial10_Half-Life2_Shading.pdf ,半条命2游戏引擎光照分析

Course.PTR.3D.Game.Engine.Programming.eBook-LinG.rar ,3D游戏引擎编程

3D Game Engine Design.rar ,3D游戏引擎设计

3D Game Engine Design source code.rar ,3D游戏引擎设计源代码

3D.Game.Programming.All.In.One.zip ,3D游戏编程大全

Game Design – Theory and Practice.rar ,游戏设计 – 理论与闹让拍实践

game.programming.all.in.one.zip ,游戏编程大全

The Cg Tutorial – The Definitive Guide to Programmable Real-Time Graphics.rar ,CG指导 – 可编程实时图形权威指南

Tricks Of The 3D Game Programming Gurus – Advanced 3D Graphics And Rasterization.rar ,3D游戏编程大师技巧 – 高级3D图形和光栅化

Ultimate Game Design Building Game Worlds.rar ,终极游戏设计 – 创建游戏世界

Core.Techniques.And.Algorithms.In.Game.Programming.rar ,核心技术和算法在游戏编程

Simulating Humans.rar ,仿真人类

3D Lighting – History, Concepts, and Techniques.rar ,3D光照 – 历史,概念和技术

Lighting.Techniques.For.Real-Time.3D.Rendering.rar ,光照技术For实时3D渲染

Vector.Game.Math.Processors.zip ,向量游戏数学处理器

AI for Computer Games and Animation – A Cognitive Modeling Approach.rar ,AI(人工智能)for计算机游戏和动画 – 一个认知建模方案

AI.Game.Development.Synthetic.Creatures.With.Learning.And.Reactive.Behaviors.rar ,AI游戏开发 – 合成生物With学习和反应举止

AI.Techniques.for.Game.Programming.rar ,AI技术for游戏编程(含源码)

Ai.Game.Programming.Wisdom.rar ,AI游戏编程(代码)

Real_Time_Rendering.rar ,实时渲染

special.effects.game.programming.rar ,特效(特殊效果)游戏编程(含源码)

Shaders.for.Game.Programmers.and.Artists.zip ,着色器for游戏开发者和艺术家

Real-Time Shader Programming.rar ,实时着色器编程

Wordware.Publishing.Advanced.Lighting.and.Materials.With.Shaders.rar ,高级光照和材质with着色器

OReilly – Physics for Game Developers.rar ,物理for游戏开发者

GPU Programming Guide.rar ,GPU编程指南

Collision.Detection.pdf.rar ,碰撞检测

Collision.Detection.-.Algorithms.and.Applications.rar ,碰撞检测 – 算法与应用

focus.on.3D.terrain.zip ,游戏3D地形编程

Focus.On.3D.Models.zip ,游戏3D模型编程

Focus.On.2D.in.Direct3D.-.fly.pdf ,集中于Direct3D中的2D

Beginning.Game.Audio.Programming.rar ,开始游戏音频编程(含源码)

Internetworked.3D.Computer.Graphics.rar ,互连网间的3D计算机图形学

Beginning.Math.and.Physics.For.Game.Programmers.zip ,开始数学和物理for游戏编程者(PDF版)

Beginning Math and Physics for Game Programmers.rar ,开始数学和物理for游戏编程者(CHM版)

3D.Math.Primer.for.graphics.and.game.development.zip ,3D数学初步for图形和游戏开发

The art of computer game design.rar ,计算机游戏设计艺术

Sams.Beginning.3D.Game.Programming.eBook-LiB.rar ,3D游戏编程入门

MIT.Press.Rules.of.Play.Game.Design.Fundamentals.rar ,游戏设计基础

design a pc game engine.rar ,设计一个PC游戏引擎

Advanced Graphics Programming Techniques Using Opengl.rar ,高级图形编程技术用OpenGL

Real-time.Rendering.Tricks.and.Techniques.in.DirectX.rar ,DirectX实时渲染技巧与技术

Real-Time Rendering Tricks and Techniques in DirectX(src).ZIP ,DirectX实时渲染技巧与技术(源代码)

Real Time 3D Terrain Engines Using C++ And Dx9.rar ,实时3D地形引擎用C++和Dx9

MS.Press.-.Microsoft.DirectX.9.Programmable.Graphics.Pipeline.rar ,Microsoft DirectX9可编程图形管线

Wordware.Publishing.OpenGL.Game.Development.eBook-YYePG.rar ,OpenGL游戏开发

Beginning.OpenGL.Game.Programming.ebook.zip ,OpenGL游戏编程入门

OpenGL.Programming.Guide.rar ,OpenGL编程指南

Addison.Wesley.-.OpenGL.Programming.Guide.2nd.Edition.rar ,OpenGL编程指南(第二版)

Addison-Wesley,.OpenGL.Shading.Language.(2023).DDU.ShareConnector.rar ,OpenGL着色语言(2023)

Learn Vertex and Pixel Shader Programming With Directx 9.rar ,学习顶点和像素着色器编程用DirectX9

Shaderx2 – Shader Programming Tips & Tricks With Directx 9.rar ,Shaderx2 – 着色器编程提示与技巧With DirectX9

ShaderX2 Introductions and Tutorials with DirectX9.rar ,ShaderX2介绍和指导With DirectX9

Direct3D.ShaderX.-.Vertex.and.Pixel.Shader.Tips.and.Tricks.rar ,Direct3D.ShaderX – 顶点和像素着色器提示和技巧

Advanced 3D Game Programming with DirectX 9.rar ,高级3D游戏编程用DirectX 9.0(含源码,CHM版)

Advanced 3D Game Programming with DirectX 9.rar ,高级3D游戏编程用DirectX 9.0(PDF版)

DirectX 3D Graphics Programming Bible.rar ,DirectX 3D图形编程宝典

Introduction to 3D Game Programming with DirectX 9.0.rar ,介绍对3D游戏编程用DirectX9.0(含部分源代码)

Beginning.Direct3D.Game.Programming.rar ,Direct3D游戏编程入门

Beginning.DirectX9.zip ,DirectX9入门

Cutting Edge Direct 3D Programming.rar ,Cutting Edge(刀刃)Direct 3D编程

Game.Scripting.Mastery.zip ,游戏描述语言掌握

Data.Structures.for.Game.Programmers.rar ,数据结构for游戏编程者(含源码)

2_OpenGL.Extensions.-.Nvidia.rar ,OpenGL扩展(Nvidia)

Managed.DX.9.Kick.Start.Graphics.And.Game.Programming.rar ,DirectX9图形和游戏编程

OpenGL.Reference.Manual.rar ,OpenGL参考手册

OpenGL.Super.Bible.rar ,OpenGL超级宝典

Tricks of the Windows Game Programming Gurus.rar ,Windows游戏编程大师技巧

Tricks of Win Game Programming Gurus 2ed.rar ,Windows游戏编程大师技巧(第二版)

Game.Programming.Beginners.Guide.rar ,游戏编程初学者指南

Chris_Crawford_on_Game_Design.rar ,Chris Crawford写的游戏设计书

Advanced.Animation.with.DirectX.rar ,高级动画with DirectX(含源码)

Inside Direct3D.rar ,深入Direct3D

Direct3D_9_Basics.rar ,Direct3D 9基础

Sams Teach Yourself DirectX 7 in 24 Hours.rar ,教你自己DirectX7在24小时

Programming.Role.Playing.Games.with.DirectX.rar ,用DirectX编程RPG游戏(含源码)

Programming Multiplayer Games.rar ,编程多玩家游戏

Net Game Programming With Directx 9.0.rar ,网络游戏编程with Directx 9.0

Programming Linux Games.rar ,编程Linux游戏

Developing Online Games – An Insiders Guide.rar ,开发在线游戏 – 一个权威人士的指导

Game Coding Complete.rar ,游戏编码完全

Strategy Game Programming with DirectX 9.0.rar ,策略游戏编程用DirectX9.0

Strategy Game Programming with DirectX 9.0 Source Code.zip ,策略游戏编程用DirectX9.0(源代码)

Addison-Wesley – Software Engineering and Computer Games.rar ,软件工程和计算机游戏

Artificial Intelligence and Software Engineering.rar ,AI和软件工程

Game-Programming-OpenGL-C++.rar ,有关OpenGl和C++的一些资料

GBA Programming Game Boy Advance The Unofficial Guide.rar ,GBA编程非官方指南

Palm.OS.Game.Programming.zip ,Palm掌上操作系统游戏编程

Mac.Game.Programming.pdf ,苹果机游戏编程

Premier.Press.J2ME.Game.Programming.rar ,J2ME游戏编程

J2ME Game Development with MIDP2.rar ,J2ME游戏开发with MIDP2

PHP.Game.Programming.zip ,PHP语言游戏编程

Game.Programming.with.Python.Lua.And.Ruby.zip ,游戏编程用Python,Lua和Ruby语言

Apress.dot.NET.Game.Programming.with.DirectX.9.0.eBook-KB.rar ,点NET游戏编程用DirectX9

Wordware.Wireless.Game.Development.In.C.Cpp.With.BREW.chm ,无线游戏开发用C、C++ With BREW

DirectX9 User Interfaces Design and Implementation.rar ,DirectX9用户接口设计和实现

Game.Interface.Design.rar ,游戏接口设计

SAMS Teach Yourself Game Programming in 24 Hours.rar ,教你自己游戏编程在24小时

C.Game.Programming.For.Dummies.2.rar ,C游戏编程傻瓜书2

Beginners Guide to DarkBASIC Game Programming.rar ,初学者指南对DarkBASIC游戏编程

Windows Graphics Programming Win32 GDI and DirectDraw.rar ,Windows图形编程 – Win32 GDI 和 DirectDraw

Game Programming Genesis.rar ,游戏编程起步

2D.Artwork.and.3D.Modeling.for.Game.Artists.zip ,2D艺术品和3D建模for游戏艺术家

Game.Art.for.Teens.pdf ,游戏艺术for青年人

Game Development and Production.rar ,游戏开发和产品

Game.Developers.Market.Guide.rar ,游戏开发者市场指南

MIT.Press.A.History.Of.Modern.Computing.eBook-LiB.rar ,现代计算历史

The C++ Programming Language NO.3 Edition.rar ,C++编程语言(第三版)

Computer Systems A Programmers Perspective.rar ,计算机系统 – 一个编程者的透视

Intel Architecture Software Developer Manual.zip ,Intel架构软件开发者手册

Intel Itanium Assembly Language Reference.rar ,Intel Itanium架构汇编语言参考

Agile Software Development.rar ,灵活的软件开发

Code Reading The Open Source Perspective.rar ,代码阅读与开放源透视

ps2DevEnvironment.exe ,PS2开发环境

doxygen-1.3.9.1-setup.exe ,一种文档自动生成软件

wolf_source.exe ,wolf游戏(id software)源代码

doom_src.zip ,doom游戏(id software)源代码

q2src320.exe ,Quake2游戏(id software)源代码

Q3A_TA_GameSource_127.exe ,QuakeIII(id software)游戏源代码

关于doxygen 下载 linux的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。


数据运维技术 » Linux环境下的Doxygen下载与安装 (doxygen 下载 linux)