doxygen工具小结

    doxygen是一个自动文档生成工具,根据代码里写的注释,自动生成html和latex格式的文档。通常是给c++用的,通常是出html格式的,你看到的pcl网上文档就是拿doxygen生成的。

    事实上,随意一份代码,都可以拿doxygen生成一个文档,然后在本地看它的代码结构。 我们拿以难读著称的lsd-slam举个例子。

    由于你电脑里可能还没有doxygen,我们先来安装一下:    

sudo apt-get install doxygen doxygen-gui【主要是doxygen本体和它的gui模块。我在ubuntu14.04下是这两个包名。如果你不确定,请用apt-cache search doxygen查一下。】

    在该文件夹下开一个doc文件夹,把一会儿生成的文档放里头:

mkdir doc

cd doc

doxywizard【调出gui面板】


首先,建个文件夹,把lsd-slam的代码拷下来:

git clone https://github.com/tum-vision/lsd_slam.git

切到Run,点“Run doxygen",等文档生成完。然后点“show html output",就可以在浏览器里看到文档啦。如果你下一次想直接看,直接打开doc/html/index.html就可以了!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,461评论 19 139
  • 用到的组件 1、通过CocoaPods安装 2、第三方类库安装 3、第三方服务 友盟社会化分享组件 友盟用户反馈 ...
    SunnyLeong阅读 14,948评论 1 180
  • 万点河山夕阳红,披云彤,缚苍龙。 寒卷西空,奈烟波流动。 恰似幽蛇天梯通, 绿相涌,目难穷。 脊背飞鸟时相送, 声...
    轻天阅读 3,146评论 0 2
  • 静下心来思考一下,你距离上一次成功有多长时间了,为什么现在的大学生都没有了斗志,我同级的同学们他们都在过着同样...
    左撇子槿希阅读 3,318评论 0 1
  • 我穿衣服就是有什么适合的衣服就会穿或者去买,经常找同学去逛街。。。现在比较喜欢看套装🥀🥀🥀
    little_a阅读 1,872评论 0 0